File and Resource Compression for the Apple Installer
Overview
Overview 4
Features 4
SDK Contents 5
Example Script 5
Compressing the source file and fonts 5
Writing the Installer script 6
Finishing with ScriptCheck 9
Using ScriptCheck with InstaCompOne Archives 9
InstaCompOne MPW Tool
About InstaCompOneTool 10
Using the InstaCompOneTool with File Archives 10
Command Line 10
Tool Options for File Archives 11
Compressing Files 11
Viewing a File Archive 12
Removing Files from a File Archive 12
Decompressing Files 13
Using the InstaCompOneTool with Resource Archives 13
Command Line 13
Tool Options for Resource Archives 13
Compressing Resources 14
Viewing a Resource Archive 14
Removing Resources from a Resource Archive 15
Decompressing Resources 15
Compressing Font Resources 15
InstaCompOne Atom Extender
Using the InstaCompOne Atom Extender 17
Adding the InstaCompOne Atom Extender to your Installer Script 17
How the Atom Extender Locates Data Inside the Archive 17
Debugging Decompression Problems 18
InstaCompOne ScriptCheck Extension
Using the InstaCompOne ScriptCheck Extension 19
FileAndRsrcSplitterTool
About the FileAndRsrcSplitterTool 20
Using the FileAndRsrcSplitterTool with Files 20
Command Line 20
Tool Options for Splitting Files 20
Splitting Files 21
Compressing Split Files 22
Using the FileAndRsrcSplitterTool with Resources 22
Command Line 22
Tool Options for Splitting Resources 22
Splitting Resources 23
Compressing Split Resources 23
Joining Split and Compressed Files and Resources 24
Splitting Strategies 24
Overview
This chapter provides an overview of the InstaCompOne suite of tools used for adding compression/decompression support to Installer 4.0 scripts.
Overview
The InstaCompOne SDK allows developers writing scripts for Apple’s Installer 4.0 application to split and compress their source files, fonts and resources, then have them transparently decompressed and joined during the installation.
This document assumes you are familiar with MPW (Macintosh Programmers Workshop) and have experience writing Installer 4.0 scripts. See the document “Installer 4.0 Technical Guide” for detailed information on writing scripts for Installer 4.0.
Features
The InstaCompOne Installer 4.0 Compression Kit includes the following features:
n Competitive compression savings. Average savings range from 40% to 60%.
n Decompression is fast and transparent to the user. Decompression is performed entirely in memory while the data is read from the source file, freeing the user from any wait at the end of the installation.
n Fonts and other resources can be easily compressed. This allows for additional savings with very low scripting overhead. In many cases it only takes an additional reference to the InstaCompOne Atom Extender (ID 241) from a Resource or Font Atom to enable decompression.
n Compresses multiple files and resources into a single archive. This saves disk space, while enabling the scriptwriter to reduce the source files to one file per installation disk.
n Split files, fonts, and resources before compression. This allows efficient use of space within the installation disk set, reducing the need for adding additional installation disks simply because a compressed file would not fit completely onto the remaining space on an installation disk. This feature also allows files that are too large to be compressed onto a single installation disk to be included in the installation.
SDK Contents
This SDK contains all the necessary files and resources you’ll need to compress files and resources and create an Installer script that automatically decompresses your data during installation.
n InstaCompOne 1.0 Technical Guide - A guide for creating Installer scripts that use the InstaCompOne compression. (DocViewer)
n InstaCompOneTool- A MPW tool for compressing, decompressing and managing your archive file.
n FileAndRsrcSplitterTool - A MPW tool for splitting files, fonts, and resources before compressing these items into archives.
n InstaCompOneAtomExt.rsrc - A file containing resources to include in your Installer script.
n InstaCompOneSCExt.rsrc - A file containing resources to include in your ScriptCheck extension file.
n Examples - Each example contains everything needed to build the example installer script. Our examples use a makefile to perform all compression and splitting, to rez the installer script source file, and to run ScriptCheck on the example script.
InstaCompOneExample - This example is described in the next section in detail. It demonstrates the installation of a file, and installation of a font, using the InstaCompOne compression.
File Example - This example demonstrates the installation of a file by use of file compression and file splitting.
Resource Example - This example demonstrates the installation of a resource by use of resource compression and resource splitting.
Font Example - This example demonstrates the installation of a font by use of resource compression and resource splitting.
Example Script
This example describes the process of creating a very simple Installer document that installs and decompresses one application file (SimpleText) and a family of fonts (Helvetica). All necessary files required to create a working version of this script are available in the folder “InstaCompOneExample” in the InstaCompOne SDK. The process of building a working Installer script requires three mains tasks: compressing source files and fonts using the InstaCompOne MPW tool, creating and compiling the script file using the Rez MPW tool, and running the ScriptCheck MPW tool on the Installer document.
The commands shown in the discussion below are executed automatically by the Build command. These build commands can be seen in the file “Makefile”. Refer to Macintosh Programmers Workshop 3.0 Reference for more information about using the MPW Shell application and the Rez tool.
Compressing the source file and fonts
Apple’s SimpleText application is used in this example. Assuming the current directory is set to the example folder, we compress the SimpleText application into an InstaCompOne file archive with the command:
Notice that there is nothing in the data fork, and therefore is zero.
Next, we must compress our font resources. Each of the eight font resources will be compressed separately and stored as individual items within an InstaCompOne resource archive.
We compress the eight font resources with the commands:
InstaCompOneTool Helvetica -k sfnt=16033 -a part=200 -o ":Tidbits:Installation Data"
InstaCompOneTool Helvetica -k sfnt=5336 -a part=201 -o ":Tidbits:Installation Data"
InstaCompOneTool Helvetica -k NFNT=24110 -a part=202 -o ":Tidbits:Installation Data"
InstaCompOneTool Helvetica -k NFNT=22271 -a part=203 -o ":Tidbits:Installation Data"
InstaCompOneTool Helvetica -k NFNT=14739 -a part=204 -o ":Tidbits:Installation Data"
InstaCompOneTool Helvetica -k NFNT=15203 -a part=205 -o ":Tidbits:Installation Data"
InstaCompOneTool Helvetica -k NFNT=17245 -a part=206 -o ":Tidbits:Installation Data"
InstaCompOneTool Helvetica -k NFNT=17892 -a part=207 -o ":Tidbits:Installation Data"
After each font resource has been compressed into its resource archive, we can list the contents of several of these archives.
InstaCompOneTool Helvetica -k sfnt=16033 -a part=200 -o ":Tidbits:Installation Data" -l
Finally, we add the ‘FOND’ resource to the source file. It’s best to convert the resource to the type ‘iFND’, then use the encodedFONDRsrc flag in the Font Atom to signal to the Installer that the source ‘FOND’ has been encoded. We use the following command to encode and copy the ‘FOND’ resource from the file “Helvetica” into the source file “Installation Data”:
Now we’re ready to begin writing the Installer script.
Writing the Installer script
We begin writing our Installer script by including the InstaCompOne Atom Extender resource by adding the line include "InstaCompOneAtomExt.rsrc" NOT 'vers'; somewhere in our script file. The script resources are created normally with the following important points:
n We must use format 1 versions or higher of the File Atom (‘infa’) and Font Atom (‘inff’) resources because these versions allow us to specify the Atom Extender ID number. The number 241 tells Installer 4.0 to look for the Atom Extender resource (‘inex’) with this ID.
n Size, Finder attributes, and resource attribute fields are left as zero. The ScriptCheck MPW tool will fill these fields in later.
n When decompressing font resources, we must provide the Installer with the source resource type and ID. This requires us to specify each strike (size and style) individually. InstaCompOne compressed resources should always use the resource type ‘part’. The resource ID ( or part number ) can be any number between 128 and 32000, and should be a unique part number assigned by the scriptwriter.
The Installer script Rez file “InstaCompOneExample.r” is shown below in its entirety. Please note that, for sake of simplicity in demonstrating compression, this example uses old style ( pre-4.0 installer ) method for creating Custom Install packages. This example is not intended as an example of how to take advantage of 4.0 Installer interface features.
After compiling the Rez code with the Rez MPW tool, we will have an Installer document, but it still needs to have the file and resource information updated.
Finishing with ScriptCheck
The ScriptCheck MPW tool performs two important actions on your script:
n Checks for syntax errors, such as referencing a script resource that is not present in the Installer document. The ScriptCheck tool also verifies that all source files and resources exist on the source disks.
n Fills in the size, Finder attributes, and resource attribute fields we left as zero when we wrote the script. The ScriptCheck MPW tool gets this information by asking the code contained in the ScriptCheck extension file.
To begin the checking process we execute the command:
ScriptCheck 'InstaCompOneExample' -h -d -a
The ScriptCheck MPW tool is described in detail in the document “ScriptCheck 4.0 Guide”.
Using ScriptCheck with InstaCompOne Archives
To assist ScriptCheck in determining file and resource information of items contained within InstaCompOne archives, an extension file has been provided for ScriptCheck. This file enables ScriptCheck to determine size and attribute information about the original item contained within an InstaCompOne archive.
The file “InstaCompOneSCExt.rsrc” contains code that can retrieve the required information from the archive to enable ScriptCheck to correctly update the Installer document. This file is included in the InstaCompOne SDK.
To enable ScriptCheck for use with InstaCompOne archives :
n Place a copy of the file “InstaCompOneSCExt.rsrc” in the same folder as your Installer script source file ( myInstallScript.r, etc. ).
n Rename the file so that it has the same name as the install script source but uses the filename extension of “.scx”. Example : “myInstallScript.scx”
When running ScriptCheck to build the installer for InstaCompOneExample, ScriptCheck looks for a file named “InstaCompOneExample.scx” which was created in our automated build process.
InstaCompOne MPW Tool
This chapter describes the InstaCompOne MPW Tool.
About InstaCompOneTool
You’ll use the InstaCompOne MPW Tool named “InstaCompOneTool” to compress your files and resources into an archive. The InstaCompOne MPW Tool also allows you to list, remove and decompress files or resources contained in the archive.
The actual compressed data is stored differently depending on whether you are compressing files or resources:
n For files: the compressed data is stored in the data fork of an archive file.
n For resources and fonts: the compressed data is stored in a archive resource usually of type 'part'. These archive resources can be placed in any file, including an archive file that contains compressed file data in its data fork.
You'll use the InstaCompOneTool to compress and manage both archived files and archived resources. The rest of this chapter is divided in two sections: using the InstaCompOneTool with file archives and using the InstaCompOneTool with resource archives.
The InstaCompOne MPW Tool requires MPW 3.0 or newer and System 7.0 or newer. To list the help text, invoke the tool without parameters.
Using the InstaCompOneTool with File Archives
This section describes how to use InstaCompOneTool to compress and manage compressed files stored in a file archive.
fileName ... When compressing, specifies one or more files to be compressed and added to the archive file. When decompressing or removing, specifies one or more file entries in the file archive. If more than one entry exists in the archive with the same filename, you may need to use the -i option to specify the exact entry. The filename can be a single file name, partial path, or full path.
-o archiveFileName Specifies a filename, partial path, or full path to a new or existing file archive.
-i entryID Specifies a compressed file entry in the archive using the file’s unique identifier, instead of the name. This option can only be used when removing or decompressing a file entry in the archive and can be mixed with filenames. You can use multiple -i options in one command line.
-r Requests that the specified compressed files be deleted from the file archive indicated by the -o option. The compressed files can either be specified by filename or using the -i option.
-d Requests that the specified compressed file be decompressed to a file from the file archive specified in the -o option. The decompressed file is placed at the location specified in the file name path. An existing file with the same name will be replaced without warning.
-l Writes a listing of the files contained in the archive to stdout. The -l option should only be used with the -o option.
-e Requests that the data fork being compressed from the specified source files actually be stored in the file archive as coming from the resource fork. This option is required when compressing a resource fork that has been split using the FileAndRsrcSplitterTool, because this tool always places the split resource data into the data fork of the split files.
-f newFilename Renames the source file being compressed to that specified in newFilename. Since the InstaCompOne Atom Extender finds the file in the file archive based partly on the target file name, this eliminates the need to rename split files using MPW or the Finder before compressing.
Compressing Files
You can add one or more files to a new or existing archive file by specifying the files to be compressed and the archive filename. If the specified archive file does not exist, it will be created. The tool will not create folders that do not exist. If a file exists with the same name as the specified archive name, but the file is not a valid archive, an error is written to stderr. If the folders or directories specified in the path to a non-existing archive do not exist, the folders or directories will not be created, and an error is will be written to stderr.
For example, to compress the files MyBigFile and “A Large File” and add them to the archive file “Compressed Data” execute the command:
InstaCompOneTool MyBigFile "Hard Disk:A Large File" -o "Compressed Data"
If an entry for the file you are compressing and adding to the archive already exists, it will be replaced. The tool uses the name, type and creator to determine if the file is the same as one already in the archive. Each time you add or update a file in the archive a new ID is assigned to the compressed file entry.
NOTE
The suggested MPW Shell partition size is at least 4 Mb’s. Compressing large files may require an even larger partition size. u
Viewing a File Archive
You view the contents of a file archive using the -l option.
For example, to list the information about the compressed files in the file archive “Compressed Data” execute the command:
InstaCompOneTool -o "Compressed Data" -l
The listing is written to stdout.
ID File Name Type Crtr DF Org DF Cmp Svd RF Org RF Cmp Svd
Compressed files can easily be removed from an archive file by using the -r option. Specify the files by listing their filenames in the command, or use the -i option to refer to a compressed file using its unique identifier. This may be necessary when several compressed files have the same name, otherwise the first file found in the archive matching the name will be removed.
For example, let’s assume we start with the archive:
ID File Name Type Crtr DF Org DF Cmp Svd RF Org RF Cmp Svd
You’ll normally use the Atom Extender that you've included in your Installer script to perform the decompression during the installation, but the tool can also be used to decompress any file contained in a file archive.
To decompress a file, use the -d option and specify one or more filenames or file entries using the -i option. Files that are decompressed remain in the archive.
If you do not specify a file to be decompressed, all files will be decompressed. The tool places the decompressed files into the current directory and will replace any file with the same name without notification.
For example, to decompress the files MyBigFile and “A Large File” from the archive file “Compressed Data” execute the command:
InstaCompOneTool MyBigFile "Hard Disk:A Large File" -o "Compressed Data" -d
Using the InstaCompOneTool with Resource Archives
This section describes how to use the InstaCompOneTool to compress and manage compressed resource data stored in a resource archive.
Command Line
Usage when compressing and adding or replacing a resource in a resource archive:
InstaCompOneTool filename -o archiveFilename -k restype=ID -a restype=ID
Usage when decompressing, listing or removing a resource from a resource archive:
fileName When compressing, specifies the file that contains the resources to be compressed, or when decompressing, the file that the original resources will be placed. The filename can be a single file name, partial path, or full path.
-k restype=ID Specifies the type and ID of a resource to be compressed, decompressed or removed. For example, if the resource has the type 'sfnt' and the ID 5302, then the parameter should be formatted: -k sfnt=5302.
-o archiveFileName Specifies a filename, partial path, or full path to a new or existing file that contains the archive resource.
-a restype=ID Specifies the type and ID of the archive resource.
-i entryID Specifies a compressed resource in the archive using the entry’s unique identifier, instead of the resource type and ID. This option can only be used when removing or decompressing a compressed resource entry in the archive resource.
-r Requests that the specified compressed resources be deleted from the archive identified by the -o and -a options. Specify the resources to be removed by using the -k or -i option.
-d Requests that the specified compressed resources be decompressed to a file. The decompressed resources are placed in the filename found in the command. An existing resource with the same type and ID will be replaced without warning.
-l Writes a listing of the resources contained in the resource archive to stdout.
Compressing Resources
Compressing resources into a resource archive is similar to compressing files, except the archive is actually contained in a resource you choose. You’ll need to specify the archive resource type and ID using the -a option. You must also specify the name of the file that contains, or will contain this resource using the -o option.
Multiple resources (except font resources) can be placed into one resource archive, and will be found automatically by the Atom Extender and decompressed during installation. Both the MPW Tool and the Atom Extender use the original type and ID to find the resource data in the archive.
For example, to compress the resource (type ‘fred’ and ID 128) found in the file “FredRsrcs” and place it into an archive resource of type ‘part’ and ID 300 in the file “Compressed Fred Data” execute the command:
InstaCompOneTool FredRsrcs -k fred=128 -a part=300 -o "Compressed Fred Data"
Each time you add or update a resource in the archive a new ID is assigned to the compressed resource entry.
Viewing a Resource Archive
You can view the compressed resources currently contained in resource archive using the -l option.
To list information about the compressed resource in the archive resource (type ‘part’ and ID 200 ) in the file “Compressed Data” execute the command:
InstaCompOneTool -a part=200 -o "Compressed Data" -l
To decompress a resource specify these five options in the command:
n -d option, to signify that this is a decompression operation
n -o option with the filename of the file containing the resource archive
n -a option with the resource archive type and ID
n -k option with the original, uncompressed resource type and ID to decompress
n -filename or pathname of the file in which the original resource will be placed
For example, to decompress the resource ‘fred’ ID 245 to the file “My Resources” on the disk “Hard Disk” from the resource archive ‘part’ ID 128 in the file “Compressed Resources” execute the command:
Compressing font resources is very similar to compressing any other resource, except several limitations must be kept in mind. There are four common font resource types: ‘FOND’, ‘FONT’, ‘NFNT’ and ‘sfnt’. The ‘FOND’ resource describes how the other types relate, and the ‘FONT’ is an older type that is rarely used today. Therefore, the most common font resources you will compress will either be of type ‘NFNT’ or ‘sfnt’.
NOTE
Keep these important notes in mind when compressing font resources:
n Multiple font resources cannot be placed into a single resource archive ; therefore, one resource archive must be created for each original font resource. Although, any number of resource archives can be placed into a single source file, even into a file that contains a file archive in its data fork
n The ‘FOND’ resource should never be compressed or split. It’s also best to encode the ‘FOND’ resource as type ‘iFND’ whenever it’s ‘NFNT’, ‘sfnt’ or ‘FONT’ resource are compressed. An example of this encoding is described below. u
For example, to compress the resource (type ‘sfnt’ and ID 5336) found in the file “Helvetica” and place it into an archive resource of type ‘part’ and ID 200 in the file “Compressed Data” execute the command:
InstaCompOneTool Helvetica -k sfnt=5336 -a part=200 -o "Compressed Data"
The Installer will be expect to the ‘FOND’ resource located in the file you have specified in your ‘inff’ script resource. You can use the FONDEncoderTool or Rez commands to encode and copy the ‘FOND’ resources. To encode the ‘FOND’ resource and store it in the file “Compressed Data” execute the command:
The ‘FOND’ resource will be stored as a resource of type ‘iFND’ with the identical resource ID as the original ‘FOND’ resource.
NOTE
The ‘FOND’ encoding is only a feature of format version 2 of the Font Atom. Make sure to use the encodedFONDRsrc flag to signal to the Installer that the source ‘FOND’ has been encoded. u
InstaCompOne Atom Extender
This chapter describes the InstaCompOne Atom Extender.
Using the InstaCompOne Atom Extender
The InstaCompOne Atom Extender is two resources you add to your Installer script file that will be called at the appropriate time to decompress ( and optionally to join split pieces of ) a File, Resource or Font Atom’s data during the installation. This Atom Extender can only be used with archives created using the InstaCompOne MPW Tool.
Adding the InstaCompOne Atom Extender to your Installer Script
The InstaCompOne Atom Extender resources are contained in the file “InstaCompOneAtomExt.rsrc”. You’ll need to place these resources into your Installer script file so the Installer can find it. If you are using MPW to create your Installer script, simply include the following line in your Installer script Rez file (“.r” file):
include "InstaCompOneAtomExt.rsrc" NOT 'vers';
For those File, Resource and Font Atoms that are copying data contained in an InstaCompOne archive, place the number 241 in the Atom Extender ID field of the atom resource. This field is only available in format 1 or higher versions of the ‘infa’ , ‘inra’ and ‘inff’ script resources.
NOTE
For File Atoms, you’ll need to use the rsrcForkInDataFork flag to enable the Atom Extender to access the archive correctly when copying the resource fork of a compressed file. u
How the Atom Extender Locates Data Inside the Archive
The InstaCompOne Atom Extender uses different criteria to locate a file or resource in the archive than does the InstaCompOne MPW tool.
The Atom Extender uses the following strategy for find the correct data in the archive:
n For files, the Atom Extender uses only the filename and the original, uncompressed size of the data. The filename will be extracted from the target path in the 'intf' target spec resource for the file atom ( 'infa' ).
n For font resources, only the target type of the resource is used. This limitation prevents multiple compressed font resources from being stored in a single resource archive.
n For non-font resources, both the target type and target ID are used to find the entry inside the resource archive.
Most of the time you’ll never have to worry about how the data is found in the archive, because it just works!
NOTE
You may notice some degradation of decompression speed from floppy disks if a single archive contains more than 30 files. This will be addressed in a future version of the InstaCompOne Atom Extender. u
Debugging Decompression Problems
If something goes wrong during decompression, the Installer will cancel the installation with a generic error message. During your testing cycle, it’s easiest to determine the actual problem using the Installer Debugger supplied with the Installer 4.0 SDK. The InstaCompOne Atom Extender will write any error information to the Installer Debugger main window.
InstaCompOne Atom Extender error codes:
Error# 28201 The file archive or resource archive may be corrupted or is not a valid archive. The Atom Extender looks for a signature in the header of the archive, and if not found returns this error. If the signature is correct but the checksum of the header and catalog is incorrect the archive is assumed corrupted and this error is generated.
Error# 28202 The compressed file or resource was not found in the catalog of the archive. This is most often because the compressed file’s filename is incorrect in the archive when using with a File Atom. See the above section “How the Atom Extender Locates Data Inside the Archive” for information about our catalog lookup strategy.
Error# 28203 The checksum of the data that has been read does not match the value stored in the archive. The archive may be corrupted.
Error# 28204 This version of the InstaCompOne Atom Extender does not support the archive version. This might be the case if you are using an older Atom Extender with an archive created with a newer version of the compressor tool.
InstaCompOne ScriptCheck Extension
This chapter describes the InstaCompOne ScriptCheck Extension.
In order to have ScriptCheck compute the correct target size values and fill in the appropriate Finder flags and version number for a compressed file, ScriptCheck must know how to extract this information from the archive file.
Using the InstaCompOne ScriptCheck Extension
To enable ScriptCheck for use with InstaCompOne archives :
n Place a copy of the file “InstaCompOneSCExt.rsrc” in the same folder as your installer script source ( myInstallScript.r, etc. ).
n Rename the file so that it has the same name as the install script source but uses the filename extension of “.scx”. Example : “myInstallScript.scx”
NOTE
You must use version 4.0.1 or newer of the ScriptCheck tool when using the InstaCompOne ScriptCheck Extension. u
When checking a File, Resource or Font Atom which references an Atom Extender, ScriptCheck looks for a file named “yourScriptFileName.scx”, where yourScriptFileName is the same as the Installer Script file name you are checking. To create the ScriptCheck Extension for the InstaCompOne compressor, just rename the file “InstaCompOneSCExt.rsrc” to “yourScriptFileName.scx”. Place this file in the same directory as the Installer script you are checking.
See the document “ScriptCheck 4.0 Guide” for the gory details of how ScriptCheck extensions work.
See the section “InstaCompOne Atom Extender” in this document for a listing of the possible error code returned from the InstaCompOne ScriptCheck extension.
FileAndRsrcSplitterTool
This chapter describes the FileAndRsrcSplitterTool.
About the FileAndRsrcSplitterTool
You’ll use the MPW Tool named “FileAndRsrcSplitterTool” to split large files and resources to enable floppy disk sets to be created, or to optimize the disk space usage. Additional disk space savings are possible when the split pieces are compressed using the InstaCompOne compression tools.
The FileAndRsrcSplitterTool can split either files or individual resources. The rest of the this chapter is divided between it use with files and its use with resources.
NOTE
The FileAndRsrcSplitter MPW Tool requires MPW 3.0 or newer and System 7.0 or newer. To list the help text, invoke the tool without parameters. u
Using the FileAndRsrcSplitterTool with Files
This section describes how to split files for use with Installer 4.X. File Atom format version 1 or higher supports multiple spilt sources. Refer to the Installer 4.X Technical Guide for additional information concerning installation of split files.
fileName ... Specifies one or more files to be split. The filename can be a single file name, partial path, or full path.
NOTE
If specifying multiple source files to be split, do not use the -o option. This will allow the source filename to be used as the root name of the split files. u
-s sizeInBytes Specifies in bytes the maximum size desired for each resulting piece of the file or files to be split.
-o outputFilename Specifies the root name and the location of the created split files. The filename can be a single file name, partial path, or full path.
NOTE
If specifying multiple source files to be split, do not use the -o option. This will allow the source filename to be used as the root name of the split files. u
The split file names are created by appending the appropriate suffix to the root filename along with the split number. If a resource fork is present in the source file, split files will be created with the suffix “.rsrc1”, “.rsrc2”, etc. If a data fork is present in the source file, split files will be created with the suffix “.data1”, “.data2”, etc. For example, if the specified output filename was “splitText” and the original file was split into four pieces, the filenames of the resulting files might be “splitText.rsrc1”, “splitText.rsrc2”, “splitText.rsrc3” and “splitText.data1”.
Splitting Files
You can split one or more files into separate pieces by specifying the files to be split, the maximum size in bytes for each split piece, and an optional object filename. If an object filename is specified, resulting files containing the split pieces of the original file will have '.rsrc1', '.rsrc2', etc. appended to the specified object filename. If no object filename is specified, resulting files will use the filename of the original file with '.rsrc1', '.rsrc2', etc. appended.
For example, to split the file "TeachText" into one or more pieces that are all smaller than 32k bytes execute the command:
This will generate two files named “splitTeachText.rsrc1” and “splitTeachText.rsrc2”. If a file exists with the same name as a file generated by file splitting , it will be replaced by the generated file without warning.
To instruct the Installer to join your split files into one target files during the installation you’ll need to create an entry in the File Atom’s source list for each split file. If the original source file had both a data fork and a resource fork you’ll need to create two File Atoms, one to copy the resource fork and another one to copy the data fork. This is necessary to allow ScriptCheck to correctly update the sizes. Since the split resource fork will actually be stored in the data fork of the split file you’ll need to use the rsrcForkInDataFork flag in your File Atom.
NOTE
When splitting multiple files it is necessary to use the default object filename to avoid having each set of split files being given the same set of filenames. This is accomplished by omitting the -o option ( object filename ). u
Compressing Split Files
Split files can optionally be compressed using the InstaCompOneTool then decompressed and joined automatically during installation.
The InstaCompOne decompression Atom Extender treats compressed split file just like any other file, but two important points will make sure your file archive is setup properly.
n The name of the file in the file archive must be the same as the target file name as specified in the target file spec. Since the FileAndRsrcSplitterTool creates split files with unique names, the -f option will allow you to easily compress each piece and stored with the target name. Because InstaCompOne archives allow only one item in each archive with the same filename, type and creator, it will also be necessary to compress each split piece of a file into separate file archives.
n The InstaCompOneTool maintains information about which compressed data is from the resource fork and which is from the data fork. Since all split file data is stored in the data fork of the split files you are compressing, you’ll need to tell the InstaCompOneTool which is actually from the resource fork.
For example, to compress the split files "splitTeachText.rsrc1" and "splitTeachText.rsrc2" and add them to two archive files “Compressed Data1” and “Compressed Data2” execute the commands:
If an entry for the file you are compressing and adding to the archive already exists, it will be replaced. Be careful when compressing split pieces that you specify the intended archive correctly. Adding two split pieces of the same file to an archive will result in one of the split pieces being overwritten by the other split piece.
Using the FileAndRsrcSplitterTool with Resources
This section describes how to split resources for use with Installer 4.X. Resource Atom or Font Atom format version 1 or higher supports multiple spilt sources. Refer to the Installer 4.X Technical Guide for additional information concerning installation of split resource or fonts.
Command Line
FileAndRsrcSplitterTool filename -k restype=ID -s sizeInBytes -a restype=ID -o outputFilename
Tool Options for Splitting Resources
fileName Specifies the file containing the resource to be split. The filename can be a single file name, partial path, or full path.
-k restype=ID Specifies the resource type and ID within the specified source file to be split.
-s sizeInBytes Specifies in bytes the maximum size desired for each resulting piece of the resource to be split.
-a restype=ID Specifies the resource type and initial resource ID to be assigned to resource items created within the specified output file.
You may use any unique number between 128 and 32000 as the base ID for the resulting split resources. For example, if the target type and ID given was [ -a 'curs'=128 ] and the resource was split into three pieces, the resulting resource items placed in the specified output file would be : 'curs' (128), 'curs'(129), and 'curs'(130).
If you won’t be compressing the split resource pieces, we suggest you use the resource type ‘part’. If you will be compressing the piece using the InstaCompOneTool, then leave the type the same as the original resource.
-o outputFilename Specify the filename of the file that will contain the split resource pieces. The filename can be a single file name, partial path, or full path.
Splitting Resources
You can split a resource into separate pieces by specifying the file containing the resource item to be split, the resource type and ID of the resource to be split, the maximum size in bytes for each split piece, the object filename that will contain each split resource piece, and the resource type and base ID for each of the resulting split pieces.
For example, to split the resource of type 'STR#' ID 129 within the file "TeachText", into one or more pieces that are all smaller than 2k bytes, execute the command:
FileAndRsrcSplitterTool TeachText -k ‘STR#’=129 -s 2000 -a part=1000 -o "splitResources"
This will generate two resources of type 'part' with IDs of 1000 and 1001 in the file named “splitResources”. If a resource already exists within the specified object file with the same resource type and ID, it will be replaced without warning.
To instruct the Installer to join your split resources into one target resource during the installation you’ll need to create an entry in the Resource or Font Atom’s source list for each split resource piece.
Compressing Split Resources
Split resources can optionally be compressed using the InstaCompOneTool then decompressed and joined automatically during installation.
One important point to remember when compressing split resource pieces is that the type and ID of the resource that is compressed must be the same as the target resource type and ID specified in the Resource Atom. Although there are several ways to accomplish this task in your script building process, our examples uses less than obvious MPW trickery to change the type and ID of the split resources before compressing them.
For example, to compress the split resources created within the file “splitResources” (see previous section) and add them to two archive files “Compressed Data1” and “Compressed Data2” execute the commands:
echo "include ∂"splitResources∂" 'part'(1000) AS 'STR#'(9100);" | Rez -o tempFile1
InstaCompOneTool tempFile1 -k 'STR#'=9100 -a part=1000 -o "Compressed Data1"
echo "include ∂"splitResources∂" 'part'(1001) AS 'STR#'(9100);" | Rez -o tempFile2
InstaCompOneTool tempFile2 -k 'STR#'=9100 -a part=1001 -o "Compressed Data2"
Joining Split and Compressed Files and Resources
It is not possible using the InstaCompOneTool to decompress and join files or resources that have been split and compressed. Only the Installer can join split files and resources.
Splitting Strategies
File and resource splitting is handy for reducing the disk count in install disk sets, and necessary for including files and resources that are still too large after compression to fit onto a single install disk. Since files must be split before being compressed you may need to use trial and error to determine the right split size to obtain compressed files the optimize the disk space on your floppies.
Use the following steps to help you split and compress your files to optimize disk space usage:
n First, compress the entire file using the InstaCompOne compression tool. Then calculate the "best guess" of how to split the file using the following formula:
n Run the FileAndRsrcSplitter MPW Tool on the large file, using the MaxSplitPieceSize calculated above. Then compress each split piece using the InstaCompOne MPW Tool.
n If any of the split and compressed pieces are still too large to fit onto the install disks, then repeat the splitting process using a smaller value for the maximum size of each split file piece.
We hope to eliminate this tedious process in a future version of the InstaCompOne tools.
$ d ˇ ˇˇˇˇ d
_ , Times
. +66InstaCompOne 1.0 *Technical Guide
$ (œ 6
+ ®
(Ì 6)Document Version 1.7 - September 1, 1994
° d ONLN d Ç 6ï√ (ê 65File and Resource Compression for the Apple Installer ˇ3Í d ˇ ˇˇˇˇ d
_ , Palatino
. +~-Table of Contents , Helvetica
(Ô ~ InstaCompOne 1.0 Technical Guide (ÔÉ )¶2
° d ONLN d c 6 u Å ( q 6Overview " ° ∂ u 4 u+ ° ∂ ° ∂
° d ONLN d v 6 Ç d *Overview ° d ONLN dˇˇ )0 ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ............ ° d ONLN dˇˇ ( d ° d ONLN dˇˇ (
4 ° d ONLN d Ç H é o ( ã HFeatures ° d ONLN dˇˇ )' ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ......... ° d ONLN dˇˇ ( ã o ° d ONLN dˇˇ ( ã
4 ° d ONLN d é H ö á ( ó H SDK Contents ° d ONLN dˇˇ )? ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`. ° d ONLN dˇˇ ( ó á ° d ONLN dˇˇ ( ó
5 ° d ONLN d . ö 6 ¶ | ( £ 6Example Script ° d ONLN dˇˇ )H ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`.... ° d ONLN dˇˇ ( £ | ° d ONLN dˇˇ ( £
5 ° d ONLN d ? ¶ H ≤ Ó ( Ø H%Compressing the source file and fonts ° d ONLN dˇˇ )® ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` .............................. ° d ONLN dˇˇ ( Ø Ó ° d ONLN dˇˇ ( Ø
5 ° d ONLN d g ≤ H æ ≈ ( ª H Writing the Installer script ° d ONLN dˇˇ )~ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ............ ° d ONLN dˇˇ ( ª ≈ ° d ONLN dˇˇ ( ª
6 ° d ONLN d Ü æ H » ( « HFinishing with ScriptCheck ° d ONLN dˇˇ )Å ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ........... ° d ONLN dˇˇ ( « » ° d ONLN dˇˇ ( «
9 ° d ONLN d £ H ÷' ( ” H,Using ScriptCheck with InstaCompOne Archives ° d ONLN dˇˇ )· ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ........... ° d ONLN dˇˇ ( ”' ° d ONLN dˇˇ )„9
° d ONLN d Ë ˚ 6 ™ *About InstaCompOneTool ° d ONLN dˇˇ )u ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`..................... ° d ONLN dˇˇ ( ™ ° d ONLN dˇˇ (
10 ° d ONLN d 6 ( 6-Using the InstaCompOneTool with File Archives ° d ONLN dˇˇ )· ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`................. ° d ONLN dˇˇ ( ° d ONLN dˇˇ )ı10 ° d ONLN d3 H ã ( H Command Line ° d ONLN dˇˇ )E ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ............................... ° d ONLN dˇˇ ( ã ° d ONLN dˇˇ (
10 ° d ONLN dC H+ “ (( H Tool Options for File Archives ° d ONLN dˇˇ )ä ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`........ ° d ONLN dˇˇ (( “ ° d ONLN dˇˇ ((
11 ° d ONLN de+ H7 ö (4 HCompressing Files ° d ONLN dˇˇ )T ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`.......................... ° d ONLN dˇˇ (4 ö ° d ONLN dˇˇ (4
11 ° d ONLN dz7 HC ¥ (@ HViewing a File Archive ° d ONLN dˇˇ )l ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`.................. ° d ONLN dˇˇ (@ ¥ ° d ONLN dˇˇ (@
12 ° d ONLN dîC HO Í (L H"Removing Files from a File Archive ° d ONLN dˇˇ )¢ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ (L Í ° d ONLN dˇˇ (L
12 ° d ONLN d∫O H[ § (X HDecompressing Files ° d ONLN dˇˇ )] ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`....................... ° d ONLN dˇˇ (X § ° d ONLN dˇˇ (X
13 ° d ONLN d—[ 6g) (d 61Using the InstaCompOneTool with Resource Archives ° d ONLN dˇˇ )Û ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ........... ° d ONLN dˇˇ (d) ° d ONLN dˇˇ )·13 ° d ONLN dg Hs ã (p H Command Line ° d ONLN dˇˇ )E ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ............................... ° d ONLN dˇˇ (p ã ° d ONLN dˇˇ (p
13 ° d ONLN ds H Ê (| H"Tool Options for Resource Archives ° d ONLN dˇˇ )ü ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`. ° d ONLN dˇˇ (| Ê ° d ONLN dˇˇ (|
13 ° d ONLN d< Hã Æ (à HCompressing Resources ° d ONLN dˇˇ )f ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`.................... ° d ONLN dˇˇ (à Æ ° d ONLN dˇˇ (à
14 ° d ONLN dUã Hó » (î HViewing a Resource Archive ° d ONLN dˇˇ )Å ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ........... ° d ONLN dˇˇ (î » ° d ONLN dˇˇ (î
14 ° d ONLN dsó H£ († H*Removing Resources from a Resource Archive ° d ONLN dˇˇ )à ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`.................. ° d ONLN dˇˇ († ° d ONLN dˇˇ )¯15 ° d ONLN d°£ HØ ∏ (¨ HDecompressing Resources ° d ONLN dˇˇ )r ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`................ ° d ONLN dˇˇ (¨ ∏ ° d ONLN dˇˇ (¨
15 ° d ONLN dºØ Hª ƒ (∏ HCompressing Font Resources ° d ONLN dˇˇ )~ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ............ ° d ONLN dˇˇ (∏ ƒ ° d ONLN dˇˇ (∏
15
° d ONLN d⁄Õ 6fl) (€ 6InstaCompOne Atom Extender " ° ∂ fl 4fl+ ° ∂ ° ∂
° d ONLN dı‡ 6Ï Ï *$Using the InstaCompOne Atom Extender ° d ONLN dˇˇ )∑ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ............................... ° d ONLN dˇˇ (È Ï ° d ONLN dˇˇ (È
17 ° d ONLN d Ï H¯o (ı H>Adding the InstaCompOne Atom Extender to your Installer Script ° d ONLN dˇˇ (ıq ................................ ° d ONLN dˇˇ )`................... ° d ONLN dˇˇ (ıo ° d ONLN dˇˇ )õ17 ° d ONLN d_¯ HK ( H5How the Atom Extender Locates Data Inside the Archive ° d ONLN dˇˇ (M ................................ ° d ONLN dˇˇ )` ............................... ° d ONLN dˇˇ (K ° d ONLN dˇˇ )ø17 ° d ONLN dò H Á (
H Debugging Decompression Problems ° d ONLN dˇˇ )ü ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`. ° d ONLN dˇˇ (
° d ONLN dfl5 6A *,Using the InstaCompOne ScriptCheck Extension ° d ONLN dˇˇ )€ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`................... ° d ONLN dˇˇ (> ° d ONLN dˇˇ )˚19
° d ONLN dS 6e Û (a 6FileAndRsrcSplitterTool " ° ∂ e 4e+ ° ∂ ° ∂
° d ONLN d'f 6r ◊ *!About the FileAndRsrcSplitterTool ° d ONLN dˇˇ )¢ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`...... ° d ONLN dˇˇ (o ◊ ° d ONLN dˇˇ (o
20 ° d ONLN dLr 6~ ({ 6,Using the FileAndRsrcSplitterTool with Files ° d ONLN dˇˇ )“ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`...................... ° d ONLN dˇˇ ({ ° d ONLN dˇˇ ({
20 ° d ONLN d|~ Hä ã (á H Command Line ° d ONLN dˇˇ )E ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ............................... ° d ONLN dˇˇ (á ã ° d ONLN dˇˇ (á
20 ° d ONLN dåä Hñ ÷ (ì H Tool Options for Splitting Files ° d ONLN dˇˇ )ê ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`...... ° d ONLN dˇˇ (ì ÷ ° d ONLN dˇˇ (ì
20 ° d ONLN d∞ñ H¢ ã (ü HSplitting Files ° d ONLN dˇˇ )E ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ............................... ° d ONLN dˇˇ (ü ã ° d ONLN dˇˇ (ü
21 ° d ONLN d√¢ HÆ ¥ (´ HCompressing Split Files ° d ONLN dˇˇ )l ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`.................. ° d ONLN dˇˇ (´ ¥ ° d ONLN dˇˇ (´
22 ° d ONLN dfiÆ 6∫ (∑ 60Using the FileAndRsrcSplitterTool with Resources ° d ONLN dˇˇ )Á ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`............... ° d ONLN dˇˇ (∑ ° d ONLN dˇˇ )Ó22 ° d ONLN d∫ HΔ ã (√ H Command Line ° d ONLN dˇˇ )E ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ............................... ° d ONLN dˇˇ (√ ã ° d ONLN dˇˇ (√
22 ° d ONLN d"Δ H“ Í (œ H$Tool Options for Splitting Resources ° d ONLN dˇˇ )¢ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ (œ Í ° d ONLN dˇˇ (œ
22 ° d ONLN dJ“ Hfi ü (€ HSplitting Resources ° d ONLN dˇˇ )W ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`......................... ° d ONLN dˇˇ (€ ü ° d ONLN dˇˇ (€
23 ˇÑ d ˇ ˇˇˇˇ d
_ , Palatino
. +~-Table of Contents , Helvetica
(Ô ~ InstaCompOne 1.0 Technical Guide (ÔÉ )¶3
° d ONLN d Q H ] » ( Z HCompressing Split Resources ° d ONLN dˇˇ )Å ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ........... ° d ONLN dˇˇ ( Z » ° d ONLN dˇˇ ( Z
23 ° d ONLN d ] H i% ( f H0Joining Split and Compressed Files and Resources ° d ONLN dˇˇ )fi ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ............ ° d ONLN dˇˇ ( f% ° d ONLN dˇˇ )Â24 ° d ONLN d S i 6 u ë ( r 6Splitting Strategies ° d ONLN dˇˇ )] ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ............................. ° d ONLN dˇˇ ( r ë ° d ONLN dˇˇ ( r
24 ˇ
D d ˇ ˇˇˇˇ d
_ , Palatino
. +~-C H A P T E R 1 , Helvetica
(Ô ~ InstaCompOne 1.0 Technical Guide (ÔÉ )¶4
$ ° d ONLN d Q ~ y ( o ~Overview " ° ∂ 4+ ° ∂ ° ∂
° d ONLN d ~* *∏TThis chapter provides an overview of the InstaCompOne suite of tools used for adding ° d ONLN d ^* ~6Ö * ;compression/decompression support to Installer 4.0 scripts.
° d ONLN d öN 6b É (] 6Overview " ° ∂ b 4b+ ° ∂ ° ∂
° d ONLN d £g ~sÙ +HPThe InstaCompOne SDK allows developers writing scripts for Apple’s Installer 4.0 ° d ONLN d Ùs ~ * Yapplication to split and compress their source files, fonts and resources, then have them ° d ONLN dN ~ãö * >transparently decompressed and joined during the installation. ° d ONLN dçì ~ü# *TThis document assumes you are familiar with MPW (Macintosh Programmers Workshop) and ° d ONLN d‚ü ~´) * `have experience writing Installer 4.0 scripts. See the document “Installer 4.0 Technical Guide” ° d ONLN dC´ ~∑à * >for detailed information on writing scripts for Installer 4.0.
° d ONLN dãfi ~ÍÏ *OThe InstaCompOne Installer 4.0 Compression Kit includes the following features: ,
Zapf Dingbats
° d ONLN d€Ù ~˝ Ö *n
° d ONLN d›Ú ê˛+ )!Competitive compression savings. ° d ONLN d˛Ú+˛‚ )õ' Average savings range from 40% to 60%.
° d ONLN d& ~ Ö ( ~n
° d ONLN d( êq )3Decompression is fast and transparent to the user. ° d ONLN d[q# )·' Decompression is performed entirely in ° d ONLN dÉ ê ! ( êYmemory while the data is read from the source file, freeing the user from any wait at the ° d ONLN d› ê* ˘ * end of the installation.
° d ONLN dˆ4 ~= Ö (; ~n
° d ONLN d¯2 ê>t )3Fonts and other resources can be easily compressed. ° d ONLN d+2t> )‰$ This allows for additional savings ° d ONLN dP> êJ (G êYwith very low scripting overhead. In many cases it only takes an additional reference to ° d ONLN d™J êV * Nthe InstaCompOne Atom Extender (ID 241) from a Resource or Font Atom to enable ° d ONLN d˘V êb ‘ * decompression.
° d ONLN d l ~u Ö (s ~n
° d ONLN d j êv¶ )?Compresses multiple files and resources into a single archive. ° d ONLN dJj¶v (s¶ This saves disk space, ° d ONLN dbv êÇ" ( ê]while enabling the scriptwriter to reduce the source files to one file per installation disk.
° d ONLN d¿å ~ï Ö (ì ~n
° d ONLN d¬ä êñu )6Split files, fonts, and resources before compression. ° d ONLN d¯äuñ )Â# This allows efficient use of space ° d ONLN d ñ ê¢ (ü êVwithin the installation disk set, reducing the need for adding additional installation ° d ONLN ds¢ êÆ! * Xdisks simply because a compressed file would not fit completely onto the remaining space ° d ONLN dÃÆ ê∫ * [on an installation disk. This feature also allows files that are too large to be compressed ° d ONLN d(∫ êΔ∞ * Conto a single installation disk to be included in the installation. ˇ† d ˇ ˇˇˇˇ d
d ~ p *YThis SDK contains all the necessary files and resources you’ll need to compress files and ° d ONLN d g p ~ | * Yresources and create an Installer script that automatically decompresses your data during ° d ONLN d ¡ | ~ à ∏ *
installation. ,
Zapf Dingbats
° d ONLN d œ í ~ õ Ö *n
° d ONLN d — ê ê ú )VInstaCompOne 1.0 Technical Guide - A guide for creating Installer scripts that use the ° d ONLN d( ú ê ®M * &InstaCompOne compression. (DocViewer)
° d ONLN dO ≤ ~ ª Ö ( π ~n
° d ONLN dQ ∞ ê º )MInstaCompOneTool- A MPW tool for compressing, decompressing and managing your ° d ONLN dü º ê » *
archive file.
° d ONLN d≠ “ ~ € Ö ( Ÿ ~n
° d ONLN dØ – ê ‹ )UFileAndRsrcSplitterTool - A MPW tool for splitting files, fonts, and resources before ° d ONLN d ‹ ê Ë= * &compressing these items into archives.
° d ONLN d, Ú ~ ˚ Ö ( ˘ ~n
° d ONLN d. ê ¸$ )[InstaCompOneAtomExt.rsrc - A file containing resources to include in your Installer script.
° d ONLN dä ~ Ö (
~n
° d ONLN då ê
)SInstaCompOneSCExt.rsrc - A file containing resources to include in your ScriptCheck ° d ONLN d‡ ê – * extension file.
° d ONLN d& ~/ Ö (- ~n
° d ONLN dÚ$ ê0 )RExamples - Each example contains everything needed to build the example installer ° d ONLN dE0 ê< * Xscript. Our examples use a makefile to perform all compression and splitting, to rez the ° d ONLN dû< êH÷ * Kinstaller script source file, and to run ScriptCheck on the example script. ° d ONLN dÎP ¢\ +QInstaCompOneExample - This example is described in the next section in detail. It ° d ONLN d=\ ¢hÛ * Ndemonstrates the installation of a file, and installation of a font, using the ° d ONLN dåh ¢t * InstaCompOne compression. ° d ONLN d¶| ¢à *RFile Example - This example demonstrates the installation of a file by use of file ° d ONLN d˘à ¢î+ * compression and file splitting. ° d ONLN dú ¢®# *UResource Example - This example demonstrates the installation of a resource by use of ° d ONLN do® ¢¥d * ,resource compression and resource splitting. ° d ONLN dúº ¢»$ *VFont Example - This example demonstrates the installation of a font by use of resource ° d ONLN dÛ» ¢‘> * #compression and resource splitting.
° d ONLN d& ~ +H]This example describes the process of creating a very simple Installer document that installs ° d ONLN dÑ ~ * Zand decompresses one application file (SimpleText) and a family of fonts (Helvetica). All ° d ONLN dfl ~) * _necessary files required to create a working version of this script are available in the folder ° d ONLN d?) ~5
* Q“InstaCompOneExample” in the InstaCompOne SDK. The process of building a working ° d ONLN dë5 ~A * ZInstaller script requires three mains tasks: compressing source files and fonts using the ° d ONLN dÏA ~M" * YInstaCompOne MPW tool, creating and compiling the script file using the Rez MPW tool, and ° d ONLN dFM ~Yì * ;running the ScriptCheck MPW tool on the Installer document. ° d ONLN dÇa ~m *RThe commands shown in the discussion below are executed automatically by the Build ° d ONLN d’m ~y⁄ * Mcommand. These build commands can be seen in the file “Makefile”. Refer to ° d ONLN d "m⁄y
(v⁄ Macintosh ° d ONLN d ,y ~Ö( (Ç ~"Programmers Workshop 3.0 Reference ° d ONLN d Ny(Ö )™/ for more information about using the MPW Shell ° d ONLN d ~Ö ~ë (é ~ application and the Rez tool.
° d ONLN d ù• ~¥i *"%Compressing the source file and fonts " ° ∂ ≥ |≥+ ° ∂ ° ∂
° d ONLN d √∏ ~ƒ$ *^Apple’s SimpleText application is used in this example. Assuming the current directory is set ° d ONLN d
"ƒ ~– * Wto the example folder, we compress the SimpleText application into an InstaCompOne file ° d ONLN d
Courier ° d ONLN d Q 6 \] ( Y 6;InstaCompOneTool SimpleText -o ":Tidbits:Installation Data"
° d ONLN d < i ~ u" +H\After the compression has finished, listing the contents of the archive shows the SimpleText ° d ONLN d ô u ~ Å
* !application as its only contents.
° d ONLN d ª Ö 6 êl ( ç 6>InstaCompOneTool SimpleText -o ":Tidbits:Installation Data" -l ° d ONLN d ˙ è 6 ö˝ *
[ID File Name Type Crtr DF Org DF Cmp Svd RF Org RF Cmp Svd ° d ONLN dV ô 6 §˝ *
[——————————————————————————————————————————————————————————————————————————————————————————— ° d ONLN d≤ £ 6 Ư *
Z 3 SimpleText APPL ttxt 0 0 0 76168 33924 56
° d ONLN d
º ~ »≠ +HENotice that there is nothing in the data fork, and therefore is zero. ° d ONLN dU ‰ ~ ! *(_Next, we must compress our font resources. Each of the eight font resources will be compressed ° d ONLN dµ ~ ¸ˇ * Rseparately and stored as individual items within an InstaCompOne resource archive. ° d ONLN d
~Å *7We compress the eight font resources with the commands:
° d ONLN dB 6 ⁄ ( 6TInstaCompOneTool Helvetica -k sfnt=16033 -a part=200 -o ":Tidbits:Installation Data" ° d ONLN dó 6)’ *
SInstaCompOneTool Helvetica -k sfnt=5336 -a part=201 -o ":Tidbits:Installation Data" ° d ONLN dÎ( 63⁄ *
TInstaCompOneTool Helvetica -k NFNT=24110 -a part=202 -o ":Tidbits:Installation Data" ° d ONLN d@2 6=⁄ *
TInstaCompOneTool Helvetica -k NFNT=22271 -a part=203 -o ":Tidbits:Installation Data" ° d ONLN dï< 6G⁄ *
TInstaCompOneTool Helvetica -k NFNT=14739 -a part=204 -o ":Tidbits:Installation Data" ° d ONLN dÍF 6Q⁄ *
TInstaCompOneTool Helvetica -k NFNT=15203 -a part=205 -o ":Tidbits:Installation Data" ° d ONLN d?P 6[⁄ *
TInstaCompOneTool Helvetica -k NFNT=17245 -a part=206 -o ":Tidbits:Installation Data" ° d ONLN dîZ 6e⁄ *
TInstaCompOneTool Helvetica -k NFNT=17892 -a part=207 -o ":Tidbits:Installation Data"
° d ONLN dÈr ~~" +H`After each font resource has been compressed into its resource archive, we can list the contents ° d ONLN dJ~ ~ä ˛ * of several of these archives.
° d ONLN dié 6ôÈ (ñ 6WInstaCompOneTool Helvetica -k sfnt=16033 -a part=200 -o ":Tidbits:Installation Data" -l ° d ONLN d¡ò 6£î *
F Type ID Name Org Size Cmp Size Svd ° d ONLN d ¢ 6≠î *
F—————————————————————————————————————————————————————————————————————— ° d ONLN dP¨ 6∑î *
F 3 sfnt 16033 Helvetica 52812 39290 26 ° d ONLN dó¿ 6ÀÈ *WInstaCompOneTool Helvetica -k NFNT=24110 -a part=202 -o ":Tidbits:Installation Data" -l ° d ONLN dÔ 6’î *
F Type ID Name Org Size Cmp Size Svd ° d ONLN d7‘ 6flî *
F—————————————————————————————————————————————————————————————————————— ° d ONLN d~fi 6Èî *
F 3 NFNT 24110 2694 1746 36
° d ONLN d≈ˆ ~ +HaFinally, we add the ‘FOND’ resource to the source file. It’s best to convert the resource to the ° d ONLN d ' ~ Ù * type ‘iFND’, then use the ° d ONLN d A ÙN )vencodedFONDRsrc ° d ONLN d PN! )Z1 flag in the Font Atom to signal to the Installer ° d ONLN d Ç ~ ( ~Ythat the source ‘FOND’ has been encoded. We use the following command to encode and copy ° d ONLN d ‹ ~& * Wthe ‘FOND’ resource from the file “Helvetica” into the source file “Installation Data”:
nB ~Np +H6Now we’re ready to begin writing the Installer script.
° d ONLN d
•b ~q *" Writing the Installer script " ° ∂ p |p+ ° ∂ ° ∂
° d ONLN d
¬u ~Å *ZWe begin writing our Installer script by including the InstaCompOne Atom Extender resource ° d ONLN d Å ~ç ” * by adding the line ° d ONLN d 0Å ”çΩ )U'include "InstaCompOneAtomExt.rsrc" NOT ° d ONLN d WÅΩç¿ )Í' ° d ONLN d XÅ¿çÿ )vers ° d ONLN d \Åÿç€ )' ° d ONLN d ]Å€ç· ); ° d ONLN d ^Å·ç! )
somewhere in ° d ONLN d lç ~ô% (ñ ~`our script file. The script resources are created normally with the following important points: ,
Zapf Dingbats
° d ONLN d Õ£ ~¨ Ö *n
° d ONLN d œ° ê≠ )XWe must use format 1 versions or higher of the File Atom (‘infa’) and Font Atom (‘inff’) ° d ONLN d (≠ êπ * Vresources because these versions allow us to specify the Atom Extender ID number. The ° d ONLN d π ê≈ * \number 241 tells Installer 4.0 to look for the Atom Extender resource (‘inex’) with this ID. ˇ@ d ˇ ˇˇˇˇ d
° d ONLN d Q ê ] )YSize, Finder attributes, and resource attribute fields are left as zero. The ScriptCheck ° d ONLN d \ ] ê iE * )MPW tool will fill these fields in later.
° d ONLN d Ü s ~ | Ö ( z ~n
° d ONLN d à q ê }& )YWhen decompressing font resources, we must provide the Installer with the source resource ° d ONLN d ‚ } ê ⡠* Ttype and ID. This requires us to specify each strike (size and style) individually. ° d ONLN d7 â ê ï * QInstaCompOne compressed resources should always use the resource type ‘part’. The ° d ONLN dâ ï ê ° * Wresource ID ( or part number ) can be any number between 128 and 32000, and should be a ° d ONLN d· ° ê ≠i * 0unique part number assigned by the scriptwriter. ° d ONLN d µ ~ ¡# ( æ ~\The Installer script Rez file “InstaCompOneExample.r” is shown below in its entirety. Please ° d ONLN do ¡ ~ Õ * ]note that, for sake of simplicity in demonstrating compression, this example uses old style ( ° d ONLN dÕ Õ ~ Ÿ * ]pre-4.0 installer ) method for creating Custom Install packages. This example is not intended ° d ONLN d+ Ÿ ~ ÂÕ * Kas an example of how to take advantage of 4.0 Installer interface features. ,
Courier
° d ONLN dw È 6 Ù Ω ( Ò 6#include "InstallerTypes.r" ° d ONLN dì Û 6 ˛ *
.include "InstaCompOneAtomExt.rsrc" NOT 'vers'; ° d ONLN d¬ 6– *R/*************************** Package resources **********************************/ ° d ONLN d 6 ≥ *
resource 'inpk' (20037) { ° d ONLN d0 H& u +
format0 { ° d ONLN d<% Z0 † +
showsOnCustom, ° d ONLN dK% ¥0m )Z%notRemovable, dontForceRestart, 0, 0, ° d ONLN ds/ Z: (7 Z'"SimpleText File Decompession Example", ° d ONLN dù9 ZD ™ *
{ 'infa', 1001 } ° d ONLN dØC HN M (K H} ° d ONLN d±M 6X @ (U 6}; ° d ONLN d¥a 6l ≥ *resource 'inpk' (20038) { ° d ONLN dœk Hv u +
{ ° d ONLN d3 l ≤ )20000, 0, 0 }, ° d ONLN dB Δ¢ )Z,/* sizes will be filled in by ScriptCheck */ ° d ONLN dq Z n ( Z0x0, ° d ONLN dx Z* d *
0, ° d ONLN d}) Z4 n *
241, ° d ONLN dÑ3 Z> d *
"" ° d ONLN dà= HH M (E H} ° d ONLN däG 6R @ (O 6}; ° d ONLN dç[ 6f– *R/*********************** Example Helvetica Font Atom ****************************/ ° d ONLN d‡e 6p Æ *
Courier ° d ONLN d Q l \ ( Y lF 0, noExtendedStyle, noCondensedStyle, noShadowStyle, noOutlineStyle, ° d ONLN d J [ H fe ( c H9noUnderlineStyle, noItalicStyle, noBoldStyle, 'sfnt', 32, ° d ONLN d à e ~ p +6
{ 20000, 'part', 200, 0, "" }, ° d ONLN d ™ o l z ( w lF 0, noExtendedStyle, noCondensedStyle, noShadowStyle, noOutlineStyle, ° d ONLN d Ù y H Ñ$ ( Å H,noUnderlineStyle, noItalicStyle, boldStyle, ° d ONLN d! y2 Ñi )Í 'sfnt', 32, ° d ONLN d1 É ~ é ( ã ~ { 20000, 'part', 201, 0, "" }, ° d ONLN dS ç l ò ( ï lF 9, noExtendedStyle, noCondensedStyle, noShadowStyle, noOutlineStyle, ° d ONLN dù ó H ¢e ( ü H9noUnderlineStyle, noItalicStyle, noBoldStyle, 'NFNT', 32, ° d ONLN d€ ° ~ ¨ +6
{ 20000, 'part', 202, 0, "" }, ° d ONLN d˝ ´ l ∂ ( ≥ lF10, noExtendedStyle, noCondensedStyle, noShadowStyle, noOutlineStyle, ° d ONLN dG µ H ¿e ( Ω H9noUnderlineStyle, noItalicStyle, noBoldStyle, 'NFNT', 32, ° d ONLN dÖ ø ~ +6
{ 20000, 'part', 203, 0, "" }, ° d ONLN dß … l ‘ ( — lF12, noExtendedStyle, noCondensedStyle, noShadowStyle, noOutlineStyle, ° d ONLN dÒ ” H fie ( € H9noUnderlineStyle, noItalicStyle, noBoldStyle, 'NFNT', 32, ° d ONLN d/ › ~ Ë +6
{ 20000, 'part', 204, 0, "" }, ° d ONLN dQ Á l Ú ( Ô lF14, noExtendedStyle, noCondensedStyle, noShadowStyle, noOutlineStyle, ° d ONLN dõ Ò H ¸e ( ˘ H9noUnderlineStyle, noItalicStyle, noBoldStyle, 'NFNT', 32, ° d ONLN dŸ ˚ ~ +6
{ 20000, 'part', 205, 0, "" }, ° d ONLN d˚ l (
lF18, noExtendedStyle, noCondensedStyle, noShadowStyle, noOutlineStyle, ° d ONLN dE He ( H9noUnderlineStyle, noItalicStyle, noBoldStyle, 'NFNT', 32, ° d ONLN dÉ ~$ +6
{ 20000, 'part', 206, 0, "" }, ° d ONLN d•# l. (+ lF24, noExtendedStyle, noCondensedStyle, noShadowStyle, noOutlineStyle, ° d ONLN dÔ- H8e (5 H9noUnderlineStyle, noItalicStyle, noBoldStyle, 'NFNT', 32, ° d ONLN d-7 ~B +6
{ 20000, 'part', 207, 0, "" } ° d ONLN dMA ZL i (I Z}}, ° d ONLN dSK ZV n *
241, ° d ONLN dZU Z` i *
"", ° d ONLN d`_ Zj ë *
"Helvetica" ° d ONLN dmi Ht M (q H} ° d ONLN dos 6~ @ ({ 6}; ° d ONLN drá 6í– *R/********************** SimpleText Target File Spec. ****************************/ ° d ONLN d≈ë 6ú ≥ *
"folder-user:SimpleText" ° d ONLN d@π Hƒ M (¡ H} ° d ONLN dB√ 6Œ @ (À 6}; ° d ONLN dE◊ 6‚– *R/********************* Font Suitcase Target File Spec. **************************/ ° d ONLN dò· 6Ï ≥ *
resource 'intf' (10002) { ° d ONLN d≥Î Hˆ u +
format0 { ° d ONLN døı Z m +
7noSearchForFile, typeCrNeedNotMatch, 'FFIL', 'DMOV', 0, ° d ONLN d˘ˇ Z
· *
"folder-user:Example Fonts" ° d ONLN d H M ( H} ° d ONLN d 6 @ ( 6}; ° d ONLN d' 62– *R/************************* Archive Source File Spec. ****************************/ ° d ONLN dn1 6< ≥ *
resource 'infs' (20000) { ° d ONLN dâ; HFV +
6'ircp', 'kakc', 0x1, noSearchForFile, TypeCrMustMatch, ° d ONLN d¡E HP œ *
Courier ° d ONLN d Q 6 \ä ( Y 6DRez InstaCompOneExample.r -o InstaCompOneExample -t 'kajr' -c 'kajr'
° d ONLN d E _ ~ k' +H[After compiling the Rez code with the Rez MPW tool, we will have an Installer document, but ° d ONLN d ° k ~ wù * Ait still needs to have the file and resource information updated.
° d ONLN d „ ã ~ ö" *"Finishing with ScriptCheck " ° ∂ ô | ô+ ° ∂ ° ∂
° d ONLN d ˛ û ~ ™À *GThe ScriptCheck MPW tool performs two important actions on your script: ,
Zapf Dingbats
° d ONLN dF ¥ ~ Ω Ö *n
° d ONLN dH ≤ ê æ )ZChecks for syntax errors, such as referencing a script resource that is not present in the ° d ONLN d£ æ ê * [Installer document. The ScriptCheck tool also verifies that all source files and resources ° d ONLN dˇ ê ÷ ˛ * exist on the source disks.
° d ONLN d ‡ ~ È Ö ( Á ~n
° d ONLN d fi ê Í )[Fills in the size, Finder attributes, and resource attribute fields we left as zero when we ° d ONLN dx Í ê ˆ * Twrote the script. The ScriptCheck MPW tool gets this information by asking the code ° d ONLN dÕ ˆ êV * ,contained in the ScriptCheck extension file. ° d ONLN d˙
~t ( ~5To begin the checking process we execute the command:
° d ONLN d0 6% (" 6*ScriptCheck 'InstaCompOneExample' -h -d -a
° d ONLN d[( ~4 +HXThe ScriptCheck MPW tool is described in detail in the document “ScriptCheck 4.0 Guide”.
° d ONLN d„[ ~g *\To assist ScriptCheck in determining file and resource information of items contained within ° d ONLN d@g ~s * UInstaCompOne archives, an extension file has been provided for ScriptCheck. This file ° d ONLN dñs ~ * Wenables ScriptCheck to determine size and attribute information about the original item ° d ONLN dÓ ~ãG * )contained within an InstaCompOne archive. ° d ONLN dì ~ü *ZThe file “InstaCompOneSCExt.rsrc” contains code that can retrieve the required information ° d ONLN dsü ~´) * `from the archive to enable ScriptCheck to correctly update the Installer document. This file is ° d ONLN d‘´ ~∑" * !included in the InstaCompOne SDK. ° d ONLN d¯ø ~Àê *:To enable ScriptCheck for use with InstaCompOne archives :
° d ONLN d3’ ~fi Ö *n
° d ONLN d5” êfl )VPlace a copy of the file “InstaCompOneSCExt.rsrc” in the same folder as your Installer ° d ONLN dåfl êÎP * /script source file ( myInstallScript.r, etc. ).
$ ° d ONLN d Q ~ y( ( o ~InstaCompOne MPW Tool " ° ∂ 4+ ° ∂ ° ∂
° d ONLN d ~*p *∏1This chapter describes the InstaCompOne MPW Tool.
° d ONLN d HB 6V (Q 6About InstaCompOneTool " ° ∂ V 4V+ ° ∂ ° ∂
° d ONLN d _[ ~g +HTYou’ll use the InstaCompOne MPW Tool named “InstaCompOneTool” to compress your files ° d ONLN d ¥g ~s * Yand resources into an archive. The InstaCompOne MPW Tool also allows you to list, remove ° d ONLN ds ~Ñ * ;and decompress files or resources contained in the archive. ° d ONLN dJá ~ì *YThe actual compressed data is stored differently depending on whether you are compressing ° d ONLN d§ì ~ü À * files or resources: ,
° d ONLN d}C 6Wƒ (R 6-Using the InstaCompOneTool with File Archives " ° ∂ W 4W+ ° ∂ ° ∂
° d ONLN d´\ ~h" +HZThis section describes how to use InstaCompOneTool to compress and manage compressed files ° d ONLN dh ~t È * stored in a file archive.
° d ONLN d!à ~ó fi *" Command Line " ° ∂ ñ |ñ+ ° ∂ ° ∂
° d ONLN d.õ ~ßS */Usage when compressing files in a file archive: ,
Courier ° d ONLN d^´ ~∑‡ *;InstaCompOneTool filename -o archiveFilename [-e] [-f name] ° d ONLN dõ≈ ~—ƒ *HUsage when decompressing, listing or removing files from a file archive: ˇÿ d ˇ ˇˇˇˇ d
° d ONLN d Q ~ ]¯ ( Z ~?InstaCompOneTool [-d|-l|-r] filename [-i ID] -o archiveFilename
° d ONLN d A l ~ {5 * Tool Options for File Archives " ° ∂ z | z+ ° ∂ ° ∂
° d ONLN d ` ~ ã “ * fileName ... ° d ONLN d m ã& )ê>When compressing, specifies one or more files to be compressed ° d ONLN d ¨ ã ó * 5and added to the archive file. When decompressing or ° d ONLN d ‚ ó £& * Aremoving, specifies one or more file entries in the file archive. ° d ONLN d% £ Ø * :If more than one entry exists in the archive with the same ° d ONLN d` Ø ª) * @filename, you may need to use the -i option to specify the exact ° d ONLN d° ª «' * @entry. The filename can be a single file name, partial path, or ° d ONLN d‚ « ”; *
full path. ° d ONLN dÔ € ~ Á ¸ ( ‰ ~-o archiveFileName ° d ONLN d € Á )ê<Specifies a filename, partial path, or full path to a new or ° d ONLN d? Á Ûn * existing file archive. ° d ONLN dV ˚ ~ ƒ ( ~
-i entryID ° d ONLN da ˚ )ê:Specifies a compressed file entry in the archive using the ° d ONLN dú * ?file’s unique identifier, instead of the name. This option can ° d ONLN d‹ * ;only be used when removing or decompressing a file entry in ° d ONLN d + * 9the archive and can be mixed with filenames. You can use ° d ONLN dR+7¬ * (multiple -i options in one command line. ° d ONLN d{? ~K å (H ~-r ° d ONLN d~?K )ê<Requests that the specified compressed files be deleted from ° d ONLN dªKW * <the file archive indicated by the -o option. The compressed ° d ONLN d¯Wc% * Afiles can either be specified by filename or using the -i option. ° d ONLN d:k ~w å (t ~-d ° d ONLN d=kw) )ê>Requests that the specified compressed file be decompressed to ° d ONLN d|wÉ * =a file from the file archive specified in the -o option. The ° d ONLN d∫Éè * <decompressed file is placed at the location specified in the ° d ONLN d˜èõ * <file name path. An existing file with the same name will be ° d ONLN d4õßá * replaced without warning. ° d ONLN dNØ ~ª å (∏ ~-l ° d ONLN dQت' )êAWrites a listing of the files contained in the archive to stdout. ° d ONLN d˙ * 5The -l option should only be used with the -o option. ° d ONLN d œ ~€ å (ÿ ~-e ° d ONLN dÕœ€ )ê5Requests that the data fork being compressed from the ° d ONLN d€Á! * @specified source files actually be stored in the file archive as ° d ONLN dDÁÛ * <coming from the resource fork. This option is required when ° d ONLN dÅÛˇ
* 9compressing a resource fork that has been split using the ° d ONLN dªˇ % * <FileAndRsrcSplitterTool, because this tool always places the ° d ONLN d¯ * :split resource data into the data fork of the split files. ° d ONLN d3 ~+ ‡ (( ~-f newFilename ° d ONLN dB + )ê=Renames the source file being compressed to that specified in ° d ONLN dÄ+7 * 8newFilename. Since the InstaCompOne Atom Extender finds ° d ONLN dπ7C * <the file in the file archive based partly on the target file ° d ONLN dˆCO * :name, this eliminates the need to rename split files using ° d ONLN d1O[æ * %MPW or the Finder before compressing.
° d ONLN dWo ~~ Û (z ~Compressing Files " ° ∂ } |}+ ° ∂ ° ∂
° d ONLN diÇ ~é *]You can add one or more files to a new or existing archive file by specifying the files to be ° d ONLN d«é ~ö * ^compressed and the archive filename. If the specified archive file does not exist, it will be ° d ONLN d &ö ~¶# * bcreated. The tool will not create folders that do not exist. If a file exists with the same name ° d ONLN d ⶠ~≤# * bas the specified archive name, but the file is not a valid archive, an error is written to stderr. ° d ONLN d Ï≤ ~æ * _If the folders or directories specified in the path to a non-existing archive do not exist, the ° d ONLN d
Læ ~ Ë * Vfolders or directories will not be created, and an error is will be written to stderr. ˇæ d ˇ ˇˇˇˇ d
° d ONLN d Q ~ ]' ( Z ~[For example, to compress the files MyBigFile and “A Large File” and add them to the archive ° d ONLN d \ ] ~ iO * +file “Compressed Data” execute the command: ,
Courier
° d ONLN d à m 6 x£ ( u 6IInstaCompOneTool MyBigFile "Hard Disk:A Large File" -o "Compressed Data"
° d ONLN d “ { ~ á& +HaIf an entry for the file you are compressing and adding to the archive already exists, it will be ° d ONLN d4 á ~ ì * _replaced. The tool uses the name, type and creator to determine if the file is the same as one ° d ONLN dî ì ~ ü) * _already in the archive. Each time you add or update a file in the archive a new ID is assigned ° d ONLN dÙ ü ~ ´ ˛ * to the compressed file entry.
° d ONLN d µ ~ ¿ ö *NOTE
° d ONLN d √ ~ œ *WThe suggested MPW Shell partition size is at least 4 Mb’s. Compressing large files may ° d ONLN do œ ~ €) * )require an even larger partition size. ,
Zapf Dingbats
° d ONLN dò —) ⁄0 )´u
° d ONLN dö Ô ~ ˛ ( ˙ ~Viewing a File Archive " ° ∂ ˝ | ˝+ ° ∂ ° ∂
° d ONLN d± ~É *<You view the contents of a file archive using the -l option. ° d ONLN dÔ ~"Ô *SFor example, to list the information about the compressed files in the file archive ° d ONLN dC" ~.< * &“Compressed Data” execute the command:
° d ONLN d∑P 6[’ (X 6SID File Name Type Crtr DF Org DF Cmp Svd RF Org RF Cmp Svd ° d ONLN d Z 6e’ *
S——————————————————————————————————————————————————————————————————————————————————— ° d ONLN d_d 6o– *
R 7 General Controls cdev misc 0 0 0 58658 20700 65 ° d ONLN d≤n 6y– *
R 9 Labels cdev flbs 0 0 0 2922 915 69 ° d ONLN dx 6É– *
R 12 Mouse cdev mous 0 0 0 18339 15015 19 ° d ONLN dXÇ 6ç– *
R 20 Views cdev fvew 0 0 0 2921 841 72 ° d ONLN d´å 6ó’ *
S——————————————————————————————————————————————————————————————————————————————————— ° d ONLN dˇñ 6°– *
R TOTALS 0 0 0 82840 37471 45
° d ONLN dR∞ ~øV +H "Removing Files from a File Archive " ° ∂ æ |æ+ ° ∂ ° ∂
° d ONLN du√ ~œ *\Compressed files can easily be removed from an archive file by using the -r option. Specify ° d ONLN d“œ ~€( * bthe files by listing their filenames in the command, or use the -i option to refer to a compressed ° d ONLN d5€ ~Á& * _file using its unique identifier. This may be necessary when several compressed files have the ° d ONLN dïÁ ~Û" * [same name, otherwise the first file found in the archive matching the name will be removed. ° d ONLN dÒ˚ ~l *4For example, let’s assume we start with the archive:
° d ONLN d& 6’ ( 6SID File Name Type Crtr DF Org DF Cmp Svd RF Org RF Cmp Svd ° d ONLN dz 6 ’ *
S——————————————————————————————————————————————————————————————————————————————————— ° d ONLN dŒ 6*– *
R 1 LaserWriter PRER LWRW 0 0 0 268960 169589 37 ° d ONLN d !) 64– *
R 2 LaserWriter 300 PRER LWL2 0 0 0 318151 144917 55 ° d ONLN d t3 6>– *
R 3 LW Select 310 PRES lwsl 0 0 0 268973 171945 37 ° d ONLN d «= 6H– *
R 4 Personal LaserWriter SC PRER LWSC 0 0 0 72716 37332 49 ° d ONLN d
G 6R– *
R 5 StyleWriter II PRER IJR2 0 0 0 301358 137184 55 ° d ONLN d
mQ 6\– *
R 6 LaserWriter TEXT ???? 11311 3793 67 571 336 42 ° d ONLN d
¿[ 6f– *
R 7 LaserWriter II NT TEXT ???? 11830 3600 70 571 346 40 ° d ONLN d e 6p– *
R 8 LaserWriter II NTX TEXT ???? 11957 3679 70 571 346 40 ° d ONLN d fo 6z– *
R 9 LaserWriter Pro 810f TEXT ???? 29434 6207 79 571 414 28 ° d ONLN d πy 6Ñ– *
R 10 LaserWriter Select 360 TEXT ???? 20738 5269 75 573 396 31 ° d ONLN d É 6é’ *
S——————————————————————————————————————————————————————————————————————————————————— ° d ONLN d `ç 6ò– *
R TOTALS 85270 22548 74 1233015 662805 47
° d ONLN d ≥õ ~ß˚ +HRTo remove the StyleWriter II and LaserWriter files from the archive we execute the ° d ONLN d
° d ONLN d7 ¸ ~% *^You’ll normally use the Atom Extender that you've included in your Installer script to perform ° d ONLN dñ ~" * _the decompression during the installation, but the tool can also be used to decompress any file ° d ONLN dˆ ~ ˘ * contained in a file archive. ° d ONLN d( ~4 *_To decompress a file, use the -d option and specify one or more filenames or file entries using ° d ONLN dt4 ~@• * Bthe -i option. Files that are decompressed remain in the archive. ° d ONLN d∑H ~T" *aIf you do not specify a file to be decompressed, all files will be decompressed. The tool places ° d ONLN dT ~`) * ^the decompressed files into the current directory and will replace any file with the same name ° d ONLN dx` ~l fi * without notification. ° d ONLN dêt ~Ä *WFor example, to decompress the files MyBigFile and “A Large File” from the archive file ° d ONLN dËÄ ~å< * &“Compressed Data” execute the command:
° d ONLN dê 6õ≤ (ò 6LInstaCompOneTool MyBigFile "Hard Disk:A Large File" -o "Compressed Data" -d
° d ONLN d\Æ 6¬Û *%1Using the InstaCompOneTool with Resource Archives " ° ∂ ¬ 4¬+ ° ∂ ° ∂
° d ONLN dé« ~” +HXThis section describes how to use the InstaCompOneTool to compress and manage compressed ° d ONLN dÁ” ~fl: * +resource data stored in a resource archive.
° d ONLN dÛ ~ fi *" Command Line " ° ∂ |+ ° ∂ ° ∂
° d ONLN d! ~Í *PUsage when compressing and adding or replacing a resource in a resource archive: ° d ONLN dr ~"Ï *=InstaCompOneTool filename -o archiveFilename -k restype=ID -a ° d ONLN d∞! ~- ∫ *
restype=ID ° d ONLN dª; ~GÓ *QUsage when decompressing, listing or removing a resource from a resource archive: ° d ONLN d
K ~W *CInstaCompOneTool [-d|-l|-r] filename -o archiveFilename [-i ID] [-k ° d ONLN d QV ~b * restype=ID] -a restype=ID
° d ONLN d lq ~Ä[ * "Tool Options for Resource Archives " ° ∂ |+ ° ∂ ° ∂
° d ONLN d èÑ ~ê ∂ *fileName ° d ONLN d òÑê )ê6When compressing, specifies the file that contains the ° d ONLN d œêú * ;resources to be compressed, or when decompressing, the file ° d ONLN d
ú® * =that the original resources will be placed. The filename can ° d ONLN d
I®¥Á * 2be a single file name, partial path, or full path. ° d ONLN d
~º ~» Ÿ (≈ ~
-k restype=ID ° d ONLN d
庻
)ê9Specifies the type and ID of a resource to be compressed, ° d ONLN d
Δ»‘) * >decompressed or removed. For example, if the resource has the ˇ¯ d ˇ ˇˇˇˇ d
° d ONLN d Q ] ( Z9type 'sfnt' and the ID 5302, then the parameter should be ° d ONLN d : ] i} * formatted: -k sfnt=5302. ,
Courier ° d ONLN d U q ~ } ¸ ( z ~-o archiveFileName ° d ONLN d h q } )ê<Specifies a filename, partial path, or full path to a new or ° d ONLN d • } ≠* 1existing file that contains the archive resource. ° d ONLN d ◊ ë ~ ù Ÿ ( ö ~
-a restype=ID ° d ONLN d  ë ùÓ )ê2Specifies the type and ID of the archive resource. ° d ONLN d • ~ ± ƒ ( Æ ~
-i entryID ° d ONLN d# • ± )ê8Specifies a compressed resource in the archive using the ° d ONLN d\ ± Ω * ?entry’s unique identifier, instead of the resource type and ID. ° d ONLN dù Ω …( * =This option can only be used when removing or decompressing a ° d ONLN d€ … ’Ì * 2compressed resource entry in the archive resource. ° d ONLN d › ~ È å ( Ê ~-r ° d ONLN d › È )ê;Requests that the specified compressed resources be deleted ° d ONLN dM È ı" * >from the archive identified by the -o and -a options. Specify ° d ONLN då ı * 9the resources to be removed by using the -k or -i option. ° d ONLN dΔ ~ å ( ~-d ° d ONLN d… ı )ê3Requests that the specified compressed resources be ° d ONLN d˝!' * >decompressed to a file. The decompressed resources are placed ° d ONLN d<!- * ;in the filename found in the command. An existing resource ° d ONLN dx-9% * ;with the same type and ID will be replaced without warning. ° d ONLN d¥A ~M å (J ~-l ° d ONLN d∑AM )ê;Writes a listing of the resources contained in the resource ° d ONLN dÛMY^ * archive to stdout.
° d ONLN d Ä ~å *YCompressing resources into a resource archive is similar to compressing files, except the ° d ONLN dvå ~ò * [archive is actually contained in a resource you choose. You’ll need to specify the archive ° d ONLN d“ò ~§
* Zresource type and ID using the -a option. You must also specify the name of the file that ° d ONLN d-§ ~∞} * <contains, or will contain this resource using the -o option. ° d ONLN dj∏ ~ƒ *_Multiple resources (except font resources) can be placed into one resource archive, and will be ° d ONLN d ƒ ~– * Xfound automatically by the Atom Extender and decompressed during installation. Both the ° d ONLN d#– ~‹& * \MPW Tool and the Atom Extender use the original type and ID to find the resource data in the ° d ONLN dÄ‹ ~Ë • * archive. ° d ONLN dâ ~¸( *`For example, to compress the resource (type ‘fred’ and ID 128) found in the file “FredRsrcs” and ° d ONLN d͸ ~! * ^place it into an archive resource of type ‘part’ and ID 300 in the file “Compressed Fred Data” ° d ONLN dI ~ ‡ * execute the command:
° d ONLN d^ 6#∑ ( 6MInstaCompOneTool FredRsrcs -k fred=128 -a part=300 -o "Compressed Fred Data"
° d ONLN d¨1 ~= +H\Each time you add or update a resource in the archive a new ID is assigned to the compressed ° d ONLN d = ~I ø * resource entry.
° d ONLN d] ~l, *"Viewing a Resource Archive " ° ∂ k |k+ ° ∂ ° ∂
° d ONLN d4p ~| *ZYou can view the compressed resources currently contained in resource archive using the -l ° d ONLN dè| ~à û * option. ° d ONLN dòê ~ú *]To list information about the compressed resource in the archive resource (type ‘part’ and ID ° d ONLN dˆú ~®É * 8200 ) in the file “Compressed Data” execute the command:
° d ONLN d /¨ 6∑? (¥ 65InstaCompOneTool -a part=200 -o "Compressed Data" -l
° d ONLN d e∫ ~Δ
+H!The listing is written to stdout.
° d ONLN d à 6’î (“ 6F Type ID Name Org Size Cmp Size Svd ° d ONLN d –‘ 6flî *
F—————————————————————————————————————————————————————————————————————— ˇ^ d ˇ ˇˇˇˇ d
Courier ° d ONLN d Q 6 \î ( Y 6F 1 sfnt 5336 Helvetica Bold 51624 38356 26
° d ONLN d G k ~ z¢ +H *Removing Resources from a Resource Archive " ° ∂ y | y+ ° ∂ ° ∂
° d ONLN d r ~ ~ äˇ *UTo remove a resource entry from an archive specify these four options in the command: ,
Zapf Dingbats
° d ONLN d » î ~ ù Ö *n
° d ONLN d í ê ûv )5-r option, to signify that this is a remove operation
° d ONLN d ® ~ ± Ö ( Ø ~n
° d ONLN d ¶ ê ≤Õ )G-o option with the filename of the file containing the resource archive
° d ONLN dJ º ~ ≈ Ö ( √ ~n
° d ONLN dL ∫ ê Δh )/-a option with the resource archive type and ID
° d ONLN d| – ~ Ÿ Ö ( ◊ ~n
° d ONLN d~ Œ ê ⁄Ÿ )H-k option with the original, uncompressed resource type and ID to remove ° d ONLN d« ‚ ~ Ó& ( Î ~`For example, to remove the resource ‘fred’ ID 245 from the resource archive ‘part’ ID 128 in the ° d ONLN d( Ó ~ ˙b * 0file “Compressed Resources” execute the command:
° d ONLN dY ˛ 6 ( 6_InstaCompOneTool "Hard Disk:My Resources" -k fred=245 -a part=128 -o "Compressed Resources" -r
° d ONLN d—+ ~7Æ *CTo decompress a resource specify these five options in the command:
° d ONLN dA ~J Ö *n
° d ONLN d? êKò )<-d option, to signify that this is a decompression operation
° d ONLN dTU ~^ Ö (\ ~n
° d ONLN dVS ê_Õ )G-o option with the filename of the file containing the resource archive
° d ONLN dûi ~r Ö (p ~n
° d ONLN d†g êsh )/-a option with the resource archive type and ID
° d ONLN d–} ~Ü Ö (Ñ ~n
° d ONLN d“{ êáÎ )L-k option with the original, uncompressed resource type and ID to decompress
° d ONLN d ë ~ö Ö (ò ~n
° d ONLN d!è êõˆ )O-filename or pathname of the file in which the original resource will be placed ° d ONLN dq£ ~Ø (¨ ~\For example, to decompress the resource ‘fred’ ID 245 to the file “My Resources” on the disk ° d ONLN dŒØ ~ª * V“Hard Disk” from the resource archive ‘part’ ID 128 in the file “Compressed Resources” ° d ONLN d%ª ~« ‡ * execute the command:
° d ONLN d:À 6÷ (” 6_InstaCompOneTool "Hard Disk:My Resources" -k fred=245 -a part=128 -o "Compressed Resources" -d
° d ONLN döÂ ~Ù9 +H Compressing Font Resources " ° ∂ Û |Û+ ° ∂ ° ∂
° d ONLN dµ¯ ~ *\Compressing font resources is very similar to compressing any other resource, except several ° d ONLN d ~( * ^limitations must be kept in mind. There are four common font resource types: ‘FOND’, ‘FONT’, ° d ONLN dq ~ ( * \‘NFNT’ and ‘sfnt’. The ‘FOND’ resource describes how the other types relate, and the ‘FONT’ ° d ONLN dŒ ~(" * _is an older type that is rarely used today. Therefore, the most common font resources you will ° d ONLN d.( ~4V * 1compress will either be of type ‘NFNT’ or ‘sfnt’.
° d ONLN d`> ~I ö *NOTE
° d ONLN deL ~X≤ *CKeep these important notes in mind when compressing font resources:
° d ONLN d´` êl )XMultiple font resources cannot be placed into a single resource archive ; therefore, one ° d ONLN dl êx * Zresource archive must be created for each original font resource. Although, any number of ° d ONLN d_x êÑ' * `resource archives can be placed into a single source file, even into a file that contains a file ° d ONLN d¿Ñ êê ˙ * archive in its data fork
° d ONLN dŸö ~£ Ö (° ~n
° d ONLN d€ò ê§ )VThe ‘FOND’ resource should never be compressed or split. It’s also best to encode the ° d ONLN d 2§ ê∞
* R‘FOND’ resource as type ‘iFND’ whenever it’s ‘NFNT’, ‘sfnt’ or ‘FONT’ resource are ° d ONLN d Ö∞ 꺧 * >compressed. An example of this encoding is described below.
° d ONLN d Q ~ ] ( Z ~]For example, to compress the resource (type ‘sfnt’ and ID 5336) found in the file “Helvetica” ° d ONLN d ^ ] ~ i * ]and place it into an archive resource of type ‘part’ and ID 200 in the file “Compressed Data” ° d ONLN d º i ~ u ‡ * execute the command: ,
Courier
° d ONLN d — y 6 Ñ£ ( Å 6IInstaCompOneTool Helvetica -k sfnt=5336 -a part=200 -o "Compressed Data"
° d ONLN d í ~ û +H]The Installer will be expect to the ‘FOND’ resource located in the file you have specified in ° d ONLN dy û ~ ™ * [your ‘inff’ script resource. You can use the FONDEncoderTool or Rez commands to encode and ° d ONLN d’ ™ ~ ∂) * ^copy the ‘FOND’ resources. To encode the ‘FOND’ resource and store it in the file “Compressed ° d ONLN d4 ∂ ~ ¬ ˇ * Data” execute the command:
° d ONLN dO œ 6 ⁄ ( ◊ 6.FONDEncoderTool Helvetica -o "Compressed Data"
° d ONLN d~ › ~ È á +Hor
° d ONLN dÅ Ì 6 ¯∑ ( ı 6Mecho "include Helvetica 'FOND' AS 'iFND';" | Rez -o "Compressed Data" -append
° d ONLN dœ ~' +H^The ‘FOND’ resource will be stored as a resource of type ‘iFND’ with the identical resource ID ° d ONLN d. ~ * as the original ‘FOND’ resource.
$ ° d ONLN d Q ~ y◊ ( o ~InstaCompOne Atom ° d ONLN d y ~ ° *(Extender " ° ∂ A 4A+ ° ∂ ° ∂
° d ONLN d F ~RÉ *∏6This chapter describes the InstaCompOne Atom Extender.
° d ONLN d Rj 6~å (y 6$Using the InstaCompOne Atom Extender " ° ∂ ~ 4~+ ° ∂ ° ∂
° d ONLN d wÉ ~è +HZThe InstaCompOne Atom Extender is two resources you add to your Installer script file that ° d ONLN d “è ~õ$ * awill be called at the appropriate time to decompress ( and optionally to join split pieces of ) a ° d ONLN d4õ ~ß * [File, Resource or Font Atom’s data during the installation. This Atom Extender can only be ° d ONLN dêß ~≥û * ;used with archives created using the InstaCompOne MPW Tool.
° d ONLN dë ~÷ *">Adding the InstaCompOne Atom Extender to your Installer Script " ° ∂ ’ |’+ ° ∂ ° ∂
° d ONLN d ⁄ ~Ê≥ *BThe InstaCompOne Atom Extender resources are contained in the file ° d ONLN dNÊ ~Ú * \“InstaCompOneAtomExt.rsrc”. You’ll need to place these resources into your Installer script ° d ONLN d´Ú ~˛ * `file so the Installer can find it. If you are using MPW to create your Installer script, simply ° d ONLN d ˛ ~
± * Iinclude the following line in your Installer script Rez file (“.r” file): ,
Courier ° d ONLN dV ~í *.include "InstaCompOneAtomExt.rsrc" NOT 'vers'; ° d ONLN dÖ ~)! *ZFor those File, Resource and Font Atoms that are copying data contained in an InstaCompOne ° d ONLN d‡) ~5) * `archive, place the number 241 in the Atom Extender ID field of the atom resource. This field is ° d ONLN dA5 ~A * aonly available in format 1 or higher versions of the ‘infa’ , ‘inra’ and ‘inff’ script resources.
° d ONLN d\Ö ~îŸ (ê ~5How the Atom Extender Locates Data Inside the Archive " ° ∂ ì |ì+ ° ∂ ° ∂
° d ONLN díò ~§ *ZThe InstaCompOne Atom Extender uses different criteria to locate a file or resource in the ° d ONLN ḑ ~∞Z * ,archive than does the InstaCompOne MPW tool. ° d ONLN d∏ ~ƒ *WThe Atom Extender uses the following strategy for find the correct data in the archive: ˇD d ˇ ˇˇˇˇ d
_ , Palatino
. +~*C H A P T E R 3
*InstaCompOne Atom Extender , Helvetica
(Ô ~ Installer 4.0 Technical Guide (ÔÉ )ú18 ,
Zapf Dingbats
° d ONLN d S ~ \ Ö ( Z ~n
° d ONLN d Q ê ]$ )ZFor files, the Atom Extender uses only the filename and the original, uncompressed size of ° d ONLN d ] ] ê i * Xthe data. The filename will be extracted from the target path in the 'intf' target spec ° d ONLN d ∂ i ê u+ * &resource for the file atom ( 'infa' ).
° d ONLN d fi ~ à Ö ( Ü ~n
° d ONLN d ‡ } ê â )[For font resources, only the target type of the resource is used. This limitation prevents ° d ONLN d< â ê ï˘ * Rmultiple compressed font resources from being stored in a single resource archive.
° d ONLN dx Ì ~ ˘% *\You may notice some degradation of decompression speed from floppy disks if a single archive ° d ONLN d’ ˘ ~ * \contains more than 30 files. This will be addressed in a future version of the InstaCompOne ° d ONLN d2 ~ * Atom Extender.
° d ONLN df8 ~D" *]If something goes wrong during decompression, the Installer will cancel the installation with ° d ONLN dƒD ~P$ * aa generic error message. During your testing cycle, it’s easiest to determine the actual problem ° d ONLN d&P ~\ * Xusing the Installer Debugger supplied with the Installer 4.0 SDK. The InstaCompOne Atom ° d ONLN d\ ~hÔ * PExtender will write any error information to the Installer Debugger main window. ° d ONLN d—p ~|; *'InstaCompOne Atom Extender error codes: ° d ONLN d˘Ñ ~ê ∂ * Error# 28201 ° d ONLN dÑê$ )ê?The file archive or resource archive may be corrupted or is not ° d ONLN dFêú * <a valid archive. The Atom Extender looks for a signature in ° d ONLN dÉú® * ?the header of the archive, and if not found returns this error. ° d ONLN d√®¥ * >If the signature is correct but the checksum of the header and ° d ONLN d¥¿" * >catalog is incorrect the archive is assumed corrupted and this ° d ONLN dA¿Ã` * error is generated. ° d ONLN dW‘ ~‡ ∂ (› ~ Error# 28202 ° d ONLN dd‘‡$ )ê?The compressed file or resource was not found in the catalog of ° d ONLN d§‡Ï * >the archive. This is most often because the compressed file’s ° d ONLN d„ϯ * ;filename is incorrect in the archive when using with a File ° d ONLN d ¯& * ;Atom. See the above section “How the Atom Extender Locates ° d ONLN d[ * :Data Inside the Archive” for information about our catalog ° d ONLN dñ X * lookup strategy. ° d ONLN dß$ ~0 ∂ (- ~ Error# 28203 ° d ONLN d¥$0 )ê:The checksum of the data that has been read does not match ° d ONLN dÔ0<¸ * 4the value stored in the archive. The archive may be ° d ONLN d$<H< *
corrupted. ° d ONLN d2P ~\ ∂ (Y ~ Error# 28204 ° d ONLN d?P\ )ê7This version of the InstaCompOne Atom Extender does not ° d ONLN dw\h% * ?support the archive version. This might be the case if you are ° d ONLN d∑ht" * ;using an older Atom Extender with an archive created with a ° d ONLN dÛtÄ≥ * %newer version of the compressor tool. ˇ
æ d ˇ ˇˇˇˇ d
_ , Palatino
. +~-C H A P T E R 4 , Helvetica
(Ô ~ InstaCompOne 1.0 Technical Guide (ÔÉ )°19
$ ° d ONLN d Q ~ yr ( o ~ InstaCompOne ° d ONLN d
y ~ °Â *(ScriptCheck Extension " ° ∂ A 4A+ ° ∂ ° ∂
° d ONLN d #F ~R¶ *∏>This chapter describes the InstaCompOne ScriptCheck Extension. ° d ONLN d bZ ~f( *_In order to have ScriptCheck compute the correct target size values and fill in the appropriate ° d ONLN d ¬f ~r * [Finder flags and version number for a compressed file, ScriptCheck must know how to extract ° d ONLN d r ~~. * 'this information from the archive file.
° d ONLN duØ ~ªê +H:To enable ScriptCheck for use with InstaCompOne archives : ,
Zapf Dingbats
° d ONLN d∞≈ ~Œ Ö *n
° d ONLN d≤√ êœ )VPlace a copy of the file “InstaCompOneSCExt.rsrc” in the same folder as your installer ° d ONLN d œ ê€= * *script source ( myInstallScript.r, etc. ).
° d ONLN d4Â ~Ó Ö (Ï ~n
° d ONLN d6„ êÔ )VRename the file so that it has the same name as the install script source but uses the ° d ONLN dçÔ ê˚• * >filename extension of “.scx”. Example : “myInstallScript.scx”
° d ONLN dà ~ ö (
~NOTE
° d ONLN d— ~ *WYou must use version 4.0.1 or newer of the ScriptCheck tool when using the InstaCompOne ° d ONLN d) ~+ Ì * ScriptCheck Extension.
$ ° d ONLN d Q ~ yˇ ( o ~FileAndRsrcSplitterTool " ° ∂ 4+ ° ∂ ° ∂
° d ONLN d ~*m *∏3This chapter describes the FileAndRsrcSplitterTool.
° d ONLN d LB 6VS (Q 6!About the FileAndRsrcSplitterTool " ° ∂ V 4V+ ° ∂ ° ∂
° d ONLN d n[ ~g( +H]You’ll use the MPW Tool named “FileAndRsrcSplitterTool” to split large files and resources to ° d ONLN d Ãg ~s * \enable floppy disk sets to be created, or to optimize the disk space usage. Additional disk ° d ONLN d)s ~ * Vspace savings are possible when the split pieces are compressed using the InstaCompOne ° d ONLN dÄ ~ã œ * compression tools. ° d ONLN dìì ~ü *\The FileAndRsrcSplitterTool can split either files or individual resources. The rest of the ° d ONLN dü ~´– * Mthis chapter is divided between it use with files and its use with resources.
° d ONLN d>µ ~¿ ö *NOTE
° d ONLN dC√ ~œ *WThe FileAndRsrcSplitter MPW Tool requires MPW 3.0 or newer and System 7.0 or newer. To ° d ONLN dõœ ~€| * :list the help text, invoke the tool without parameters. ,
Zapf Dingbats
° d ONLN d’—|⁄É )˛u
° d ONLN d◊Û 6¢ ( 6,Using the FileAndRsrcSplitterTool with Files " ° ∂ 4+ ° ∂ ° ∂
° d ONLN d ~" +HaThis section describes how to split files for use with Installer 4.X. File Atom format version 1 ° d ONLN df ~$ * Zor higher supports multiple spilt sources. Refer to the Installer 4.X Technical Guide for ° d ONLN d¡$ ~0é * >additional information concerning installation of split files.
° d ONLN d D ~S fi *" Command Line " ° ∂ R |R+ ° ∂ ° ∂ ,
° d ONLN dRy ~à8 * Tool Options for Splitting Files " ° ∂ á |á+ ° ∂ ° ∂
° d ONLN dså ~ò “ * fileName ... ° d ONLN dÄåò )ê?Specifies one or more files to be split. The filename can be a ° d ONLN d¿ò§” * -single file name, partial path, or full path.
° d ONLN dÔ¨∑* *NOTE
° d ONLN dÙ∂¬! * BIf specifying multiple source files to be split, do not use the -o ° d ONLN d7¬Œ * >option. This will allow the source filename to be used as the ° d ONLN dvŒ⁄è * root name of the split files.
° d ONLN dñ–èŸñ )Åu ˇñ d ˇ ˇˇˇˇ d
_ , Palatino
. +~*C H A P T E R 5
*FileAndRsrcSplitterTool , Helvetica
(‰ ~ InstaCompOne 1.0 Technical Guide (‰É )°21 ,
Courier
° d ONLN d Q ~ ] ‡ ( Z ~-s sizeInBytes ° d ONLN d Q ]& )ê>Specifies in bytes the maximum size desired for each resulting ° d ONLN d N ] i™ * 'piece of the file or files to be split. ° d ONLN d v q ~ } ı ( z ~-o outputFilename ° d ONLN d à q } )ê=Specifies the root name and the location of the created split ° d ONLN d Δ } â$ * @files. The filename can be a single file name, partial path, or ° d ONLN d â ï; *
full path.
° d ONLN d ù ®* *NOTE
° d ONLN d ß ≥! * BIf specifying multiple source files to be split, do not use the -o ° d ONLN d[ ≥ ø * >option. This will allow the source filename to be used as the ° d ONLN dö ø Àè * root name of the split files. ,
Zapf Dingbats
° d ONLN d∫ ¡è ñ )Åu
° d ONLN dΩ ” fl) ( ‹=The split file names are created by appending the appropriate ° d ONLN d˚ fl Î * >suffix to the root filename along with the split number. If a ° d ONLN d: Î ˜ * @resource fork is present in the source file, split files will be ° d ONLN d{ ˜" * Ccreated with the suffix “.rsrc1”, “.rsrc2”, etc. If a data fork is ° d ONLN dø * @present in the source file, split files will be created with the ° d ONLN d * >suffix “.data1”, “.data2”, etc. For example, if the specified ° d ONLN d?' * 9output filename was “splitText” and the original file was ° d ONLN dy'3 * <split into four pieces, the filenames of the resulting files ° d ONLN d∂3?( * Amight be “splitText.rsrc1”, “splitText.rsrc2”, “splitText.rsrc3” ° d ONLN d¯?Kv * and “splitText.data1”.
° d ONLN d_ ~n — (j ~Splitting Files " ° ∂ m |m+ ° ∂ ° ∂
° d ONLN d r ~~
*]You can split one or more files into separate pieces by specifying the files to be split, the ° d ONLN d}~ ~ä * Zmaximum size in bytes for each split piece, and an optional object filename. If an object ° d ONLN dÿä ~ñ! * afilename is specified, resulting files containing the split pieces of the original file will have ° d ONLN d:ñ ~¢˝ * ]'.rsrc1', '.rsrc2', etc. appended to the specified object filename. If no object filename is ° d ONLN dò¢ ~Æ * cspecified, resulting files will use the filename of the original file with '.rsrc1', '.rsrc2', etc. ° d ONLN d¸Æ ~∫ Æ * appended. ° d ONLN d¬ ~Œ *\For example, to split the file "TeachText" into one or more pieces that are all smaller than ° d ONLN ddŒ ~⁄ * 32k bytes execute the command:
° d ONLN d√ˆ ~ +H[This will generate two files named “splitTeachText.rsrc1” and “splitTeachText.rsrc2”. If a ° d ONLN d ~# * afile exists with the same name as a file generated by file splitting , it will be replaced by the ° d ONLN dÅ ~ * generated file without warning. ° d ONLN d°" ~. *`To instruct the Installer to join your split files into one target files during the installation ° d ONLN d. ~: * cyou’ll need to create an entry in the File Atom’s source list for each split file. If the original ° d ONLN df: ~F& * asource file had both a data fork and a resource fork you’ll need to create two File Atoms, one to ° d ONLN d»F ~R * Ycopy the resource fork and another one to copy the data fork. This is necessary to allow ° d ONLN d "R ~^% * aScriptCheck to correctly update the sizes. Since the split resource fork will actually be stored ° d ONLN d Ñ^ ~jq * :in the data fork of the split file you’ll need to use the ° d ONLN d æ^qj› )ÛrsrcForkInDataFork ° d ONLN d –^›j( )l flag in your File ° d ONLN d „j ~v ö (s ~Atom.
° d ONLN d ÈÄ ~ã ö *NOTE
° d ONLN d Óé ~ö( *`When splitting multiple files it is necessary to use the default object filename to avoid having ° d ONLN d
Oö ~¶! * _each set of split files being given the same set of filenames. This is accomplished by omitting ° d ONLN d
° d ONLN d d ~ p *YSplit files can optionally be compressed using the InstaCompOneTool then decompressed and ° d ONLN d r p ~ |8 * )joined automatically during installation. ° d ONLN d ú Ñ ~ ê *WThe InstaCompOne decompression Atom Extender treats compressed split file just like any ° d ONLN d Ù ê ~ ú * Xother file, but two important points will make sure your file archive is setup properly. ,
Zapf Dingbats
° d ONLN dM ¶ ~ Ø Ö *n
° d ONLN dO § ê ∞ )TThe name of the file in the file archive must be the same as the target file name as ° d ONLN d§ ∞ ê º * Yspecified in the target file spec. Since the FileAndRsrcSplitterTool creates split files ° d ONLN d˛ º ê » * Xwith unique names, the -f option will allow you to easily compress each piece and stored ° d ONLN dW » ê ‘ * Pwith the target name. Because InstaCompOne archives allow only one item in each ° d ONLN d® ‘ ê ‡ * Warchive with the same filename, type and creator, it will also be necessary to compress ° d ONLN d ‡ ê Ï| * 7each split piece of a file into separate file archives.
° d ONLN d8 ˆ ~ ˇ Ö ( ˝ ~n
° d ONLN d: Ù ê )RThe InstaCompOneTool maintains information about which compressed data is from the ° d ONLN dç ê * Zresource fork and which is from the data fork. Since all split file data is stored in the ° d ONLN dË ê" * Zdata fork of the split files you are compressing, you’ll need to tell the InstaCompOneTool ° d ONLN dC ê$H * )which is actually from the resource fork. ° d ONLN dm, ~8) (5 ~^For example, to compress the split files "splitTeachText.rsrc1" and "splitTeachText.rsrc2" and ° d ONLN dÃ8 ~D * Sadd them to two archive files “Compressed Data1” and “Compressed Data2” execute the ° d ONLN d D ~P Ø * commands: ,
° d ONLN d⁄l ~x& +HaIf an entry for the file you are compressing and adding to the archive already exists, it will be ° d ONLN d<x ~Ñ * Yreplaced. Be careful when compressing split pieces that you specify the intended archive ° d ONLN dñÑ ~ê * acorrectly. Adding two split pieces of the same file to an archive will result in one of the split ° d ONLN d¯ê ~ú[ * 2pieces being overwritten by the other split piece.
° d ONLN d+¥ 6»— (√ 60Using the FileAndRsrcSplitterTool with Resources " ° ∂ » 4»+ ° ∂ ° ∂
° d ONLN d\Õ ~Ÿ +H`This section describes how to split resources for use with Installer 4.X. Resource Atom or Font ° d ONLN dΩŸ ~ * \Atom format version 1 or higher supports multiple spilt sources. Refer to the Installer 4.X ° d ONLN d ~Ò * ^Technical Guide for additional information concerning installation of split resource or fonts.
° d ONLN dy ~ fi *" Command Line " ° ∂ |+ ° ∂ ° ∂
° d ONLN dÜ ~+˛ *@FileAndRsrcSplitterTool filename -k restype=ID -s sizeInBytes -a ° d ONLN d«* ~6& * restype=ID -o outputFilename
° d ONLN dÂE ~T^ * $Tool Options for Splitting Resources " ° ∂ S |S+ ° ∂ ° ∂
° d ONLN d X ~d Ω * fileName ° d ONLN d Xd )ê<Specifies the file containing the resource to be split. The ° d ONLN d Rdp# * ?filename can be a single file name, partial path, or full path. ° d ONLN d íx ~Ñ Ÿ (Å ~
-k restype=ID ° d ONLN d †xÑ% )ê>Specifies the resource type and ID within the specified source ° d ONLN d flÑêQ * file to be split. ° d ONLN d Òò ~§ ‡ (° ~-s sizeInBytes ° d ONLN d
ò§& )ê>Specifies in bytes the maximum size desired for each resulting ° d ONLN d
?§∞õ * "piece of the resource to be split. ° d ONLN d
b∏ ~ƒ Ÿ (¡ ~
-a restype=ID ° d ONLN d
p∏ƒ )ê9Specifies the resource type and initial resource ID to be ° d ONLN d
™ƒ–$ * >assigned to resource items created within the specified output * file. ˇd d ˇ ˇˇˇˇ d
_ , Palatino
. +~*C H A P T E R 5
*FileAndRsrcSplitterTool , Helvetica
(‰ ~ InstaCompOne 1.0 Technical Guide (‰É )°23
° d ONLN d Q ] ( Z:You may use any unique number between 128 and 32000 as the ° d ONLN d ; ] i * >base ID for the resulting split resources. For example, if the ° d ONLN d z i u * ?target type and ID given was [ -a 'curs'=128 ] and the resource ° d ONLN d ∫ u Å& * @was split into three pieces, the resulting resource items placed ° d ONLN d ˚ Å ç * Bin the specified output file would be : 'curs' (128), 'curs'(129), ° d ONLN d> ç ôR * and 'curs'(130). ° d ONLN dP ° ≠) *AIf you won’t be compressing the split resource pieces, we suggest ° d ONLN dí ≠ π& * Ayou use the resource type ‘part’. If you will be compressing the ° d ONLN d‘ π ≈ * 9piece using the InstaCompOneTool, then leave the type the ° d ONLN d ≈ —ì * same as the original resource. ,
Courier ° d ONLN d- Ÿ ~  ı ( ‚ ~-o outputFilename ° d ONLN d? Ÿ  )ê<Specify the filename of the file that will contain the split ° d ONLN d| Â Ò * 9resource pieces. The filename can be a single file name, ° d ONLN d∂ Ò ˝Ü * partial path, or full path.
° d ONLN dÔx 6ÉÛ (Ä 6YFileAndRsrcSplitterTool TeachText -k ‘STR#’=129 -s 2000 -a part=1000 -o "splitResources"
° d ONLN dIê ~ú +H[This will generate two resources of type 'part' with IDs of 1000 and 1001 in the file named ° d ONLN d•ú ~® * ^“splitResources”. If a resource already exists within the specified object file with the same ° d ONLN d® ~¥Ñ * :resource type and ID, it will be replaced without warning. ° d ONLN d?º ~»¯ *ZTo instruct the Installer to join your split resources into one target resource during the ° d ONLN dö» ~‘ * _installation you’ll need to create an entry in the Resource or Font Atom’s source list for each ° d ONLN d˙‘ ~‡ ◊ * split resource piece.
° d ONLN d, ~ *YSplit resources can optionally be compressed using the InstaCompOneTool then decompressed ° d ONLN dÜ ~ K * -and joined automatically during installation. ° d ONLN d¥' ~3 *[One important point to remember when compressing split resource pieces is that the type and ° d ONLN d3 ~? * YID of the resource that is compressed must be the same as the target resource type and ID ° d ONLN dj? ~K * [specified in the Resource Atom. Although there are several ways to accomplish this task in ° d ONLN dΔK ~W * \your script building process, our examples uses less than obvious MPW trickery to change the ° d ONLN d #W ~cÜ * ;type and ID of the split resources before compressing them. ° d ONLN d _k ~w *ZFor example, to compress the split resources created within the file “splitResources” (see ° d ONLN d ∫w ~É * Vprevious section) and add them to two archive files “Compressed Data1” and “Compressed ° d ONLN d
É ~è * Data2” execute the commands:
° d ONLN d
.ì 6ûŒ (õ 6Recho "include ∂"splitResources∂" 'part'(1000) AS 'STR#'(9100);" | Rez -o tempFile1 ° d ONLN d
Åù 6®≤ *
LInstaCompOneTool tempFile1 -k 'STR#'=9100 -a part=1000 -o "Compressed Data1" ° d ONLN d
œß 6≤Œ *
Recho "include ∂"splitResources∂" 'part'(1001) AS 'STR#'(9100);" | Rez -o tempFile2 ° d ONLN d "± 6º≤ *
LInstaCompOneTool tempFile2 -k 'STR#'=9100 -a part=1001 -o "Compressed Data2" ˇ – d ˇ ˇˇˇˇ d
_ , Palatino
. +~*C H A P T E R 5
*FileAndRsrcSplitterTool , Helvetica
(‰ ~ InstaCompOne 1.0 Technical Guide (‰É )°24
° d ONLN d Q ~ `∫ ( \ ~0Joining Split and Compressed Files and Resources " ° ∂ _ | _+ ° ∂ ° ∂
° d ONLN d 1 d ~ pç *<It is not possible using the InstaCompOneTool to decompress ° d ONLN d m dç pû ( mçand ° d ONLN d p dû p ) join files or resources that ° d ONLN d é p ~ |¯ ( y ~Whave been split and compressed. Only the Installer can join split files and resources.
° d ONLN d Ê î 6 ® — ( £ 6Splitting Strategies " ° ∂ ® 4 ®+ ° ∂ ° ∂
° d ONLN d ˚ ≠ ~ π +HZFile and resource splitting is handy for reducing the disk count in install disk sets, and ° d ONLN dV π ~ ≈' * dnecessary for including files and resources that are still too large after compression to fit onto a ° d ONLN dª ≈ ~ — * asingle install disk. Since files must be split before being compressed you may need to use trial ° d ONLN d — ~ › * \and error to determine the right split size to obtain compressed files the optimize the disk ° d ONLN dz › ~ È ‰ * space on your floppies. ° d ONLN dî Ò ~ ˝$ *_Use the following steps to help you split and compress your files to optimize disk space usage: ,
Zapf Dingbats
° d ONLN dÙ ~ Ö *n
° d ONLN dˆ ê )XFirst, compress the entire file using the InstaCompOne compression tool. Then calculate ° d ONLN dO ê ¬ * Fthe "best guess" of how to split the file using the following formula: ° d ONLN dó% ê1Ï *KMaxSplitPieceSize = DiskSize * ( OriginalFileSize / CompressedFileSize )
° d ONLN d„; ~D Ö (B ~n
° d ONLN dÂ9 êE )SRun the FileAndRsrcSplitter MPW Tool on the large file, using the MaxSplitPieceSize ° d ONLN d9E êQ * Rcalculated above. Then compress each split piece using the InstaCompOne MPW Tool.
° d ONLN då[ ~d Ö (b ~n
° d ONLN déY êe )\If any of the split and compressed pieces are still too large to fit onto the install disks, ° d ONLN dÎe êq# * Zthen repeat the splitting process using a smaller value for the maximum size of each split ° d ONLN dFq ê} æ * file piece. ° d ONLN dRÖ ~ë (é ~XWe hope to eliminate this tedious process in a future version of the InstaCompOne tools. ˇ
